ci: add semver

.github/workflows/main.yaml

@@ -29,31 +29,31 @@ jobs:
         pixi run python --version | grep 3.12
         pixi run test | grep "Hello, World"
 
-  # Semantic-Release:
-  #   runs-on: ubuntu-latest
-  #   if: github.event_name == 'push' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/staging' )
-  #   needs: Run-A-Pixi-Job
-  #   concurrency: release
-  #   permissions:
-  #     id-token: write
-  #     contents: write
-  #     packages: write
-  #     actions: read
-  #   steps:
-  #   - uses: actions/create-github-app-token@v1
-  #     id: app-token
-  #     with:
-  #       app-id: ${{ vars.SEMVER_APPID }}
-  #       private-key: ${{ secrets.SEMVER_SECRET }}
-
-  #   - uses: actions/checkout@v4
-  #     with:
-  #       fetch-depth: 0
+  Semantic-Release:
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/staging' )
+    needs: Run-A-Pixi-Job
+    concurrency: release
+    permissions:
+      id-token: write
+      contents: write
+      packages: write
+      actions: read
+    steps:
+    # - uses: actions/create-github-app-token@v1
+    #   id: app-token
+    #   with:
+    #     app-id: ${{ vars.SEMVER_APPID }}
+    #     private-key: ${{ secrets.SEMVER_SECRET }}
+
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
   #       token: ${{ steps.app-token.outputs.token }}
 
-  #   - name: Python Semantic Release
-  #     uses: python-semantic-release/python-semantic-release@master
-  #     with:
-  #       root_options: -vv
-  #       github_token: ${{ secrets.GITHUB_TOKEN }}
-  #       git_committer_name: 'gh-actions-semver'
+    - name: Python Semantic Release
+      uses: python-semantic-release/python-semantic-release@master
+      with:
+        root_options: -vv
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        git_committer_name: 'gh-actions-semver'

README.md

@@ -15,7 +15,7 @@ To install the dependencies, run the following command:
 pixi install
 ```
 
-What this does is create a virtual environment and install the dependencies listed in the `pyproject.toml` file. 
+What this does is create a virtual environment and install the dependencies listed in the [pyproject.toml](pyproject.toml) file.
 By starting command line commands with `pixi run`, you can run the commands in the specific environment.
 
 ```bash
@@ -26,14 +26,14 @@ pixi run python -m src.core.snakemake.main
 This ensures that any other packages or dependencies can be synchronized across different environments, systems, and developers.
 
 A feature of pixi is that it can be used to run common tasks.
-For example, the above command has been implemented as a pixi task in the `pyproject.toml` file.
+For example, the above command has been implemented as a pixi task in the [pyproject.toml](pyproject.toml) file.
 
 To run the task, use the following command:
 
 ```bash
 pixi run hello
+# > ✨ Pixi task (default): python -m src.core.main
+# > Hello, World!
 ```
 
 TODO:: as development progresses, remove the hello_world function and add a more meaningful function to show the functionality of the project and PIXI in general.
-
-