(bump:minor) Feat: Add mechanism for user-site update and auto creating releases (#56)

* move flowsettings.py and launch.py to root

* update docs

* sync sub package versions

* rename launch.py to app.py and make run scripts work with installation package

* add update scripts

* auto version for root package

* rename authors and update doc dir

* Update auto-bump-and-release.yaml to trigger on push to main branch

* latest as branch instead of tag

* pin deps versions

* cache the changelogs

.github/workflows/auto-bump-and-release.yaml

@@ -0,0 +1,47 @@
+name: Auto Bump and Release
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  auto-bump-and-release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Clone the repo
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Update Application Version
+        id: update-version
+        uses: anothrNick/github-tag-action@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          WITH_V: true
+          DEFAULT_BUMP: none
+          MAJOR_STRING_TOKEN: "bump:major"
+          MINOR_STRING_TOKEN: "bump:minor"
+          PATCH_STRING_TOKEN: "bump:patch"
+      - name: Create release for ${{ steps.update-version.outputs.new_tag }}
+        run: |
+          echo Create release folder
+          mkdir kotaemon-app
+          echo ${{ steps.update-version.outputs.new_tag }} > kotaemon-app/VERSION
+          cp LICENSE.txt kotaemon-app/
+          cp flowsettings.py kotaemon-app/
+          cp app.py kotaemon-app/
+          cp -r scripts kotaemon-app/
+          tree kotaemon-app
+          zip -r kotaemon-app.zip kotaemon-app
+      - name: Release ${{ steps.update-version.outputs.new_tag }}
+        uses: softprops/action-gh-release@v2
+        with:
+          files: kotaemon-app.zip
+          fail_on_unmatched_files: true
+          token: ${{ secrets.GITHUB_TOKEN }}
+          generate_release_notes: true
+          tag_name: ${{ steps.update-version.outputs.new_tag }}
+          make_latest: true
+      - name: Update latest branch
+        run: git branch -f latest tags/${{ steps.update-version.outputs.new_tag }}

.github/workflows/style-check.yaml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Clone the repo
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Setup python
         uses: actions/setup-python@v4
         with:

.github/workflows/unit-test.yaml

@@ -33,7 +33,7 @@ jobs:
     name: unit testing with python ${{ matrix.python-version }}
     steps:
       - name: Clone the repo
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           ref: ${{ github.event.pull_request.head.sha }}
 
@@ -56,11 +56,9 @@ jobs:
 
       - name: Get cache key
         id: get-cache-key
-        # using tomli so that it works on windows. From python 3.11, this can be switched to the
-        # built-in tomllib
         run: |
-          pip install tomli
-          package_version=$(python -c "import tomli; print(tomli.load(open('libs/kotaemon/pyproject.toml', 'rb'))['project']['version'])")
+          pip install "setuptools-git-versioning>=2.0,<3"
+          package_version=$(setuptools-git-versioning)
           cache_key="${{ runner.os }}-py${{ matrix.python-version }}-v${package_version}"
           echo "key=$cache_key" | tee -a ${{ matrix.GITHUB_OUTPUT }}
 
@@ -82,10 +80,7 @@ jobs:
           cache_hit=${{ steps.restore-dependencies.outputs.cache-primary-key == steps.restore-dependencies.outputs.cache-matched-key }}
           echo "check=$cache_hit" | tee -a ${{ matrix.GITHUB_OUTPUT }}
 
-      - name: Install dependencies if ignore caching or no cache hit
-        if: |
-          steps.check-ignore-cache.outputs.check == 'true' ||
-          steps.check-cache-hit.outputs.check != 'true'
+      - name: Install additional dependencies (if any)
         run: |
           python -m pip install --upgrade pip
           cd libs/kotaemon