Fix/release process (#16)

* Fix release process

* Review release creation

.github/workflows/release.yml

@@ -7,9 +7,6 @@ on:
 jobs:
   build:
     runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      packages: write
     steps:
       - name: Check out code
         uses: actions/checkout@v3
@@ -19,12 +16,9 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
           tag_name: ${{ github.ref }}
-          release_name: ${{ github.ref }}
+          release_name: ${{ github.ref_name }}
           draft: false
           prerelease: false
-      - name: Get short SHA
-        id: short-sha
-        run: echo "sha=$(git rev-parse --short HEAD)" >> "$GITHUB_OUTPUT"
       - name: Login to GitHub Container Registry
         uses: docker/login-action@v2
         with:
@@ -43,6 +37,5 @@ jobs:
             TARGET=prod
           tags: |
             ghcr.io/${{ github.repository }}:latest
-            ghcr.io/${{ github.repository }}:${{ github.ref }}
-            ghcr.io/${{ github.repository }}:${{ github.run_number }}-${{ steps.short-sha.outputs.sha }}
+            ghcr.io/${{ github.repository }}:${{ github.ref_name }}
           context: .

docs/developer-guide/getting-started.md

@@ -130,4 +130,14 @@ Some useful examples of how this project can be used:
     poe docker-run
     ```
 
+- Release
+
+  Switch to `main` branch locally and run
+
+  ```sh
+  ./trigger-release.sh
+  ```
+
+  which creates a new release tag which further creates a GitHub release and a container image published to GitHub registry, via GitHub Actions.
+
 _For more examples, please refer to the [Documentation](https://docqai.github.io/docq/)_

trigger-release.sh

@@ -1,6 +1,7 @@
 poe test
-VERSION=(poetry version --short)
-TAG_NAME="v${VERSION}"
+VER=`poetry version --short`
+TAG="v${VER}"
+echo "Tagging release ${TAG}"
 git tag $TAG_NAME
 git push origin $TAG_NAME