Bump version: 0.1.0 → 0.1.1

.bumpversion.toml

@@ -1,5 +1,5 @@
 [tool.bumpversion]
-current_version = "0.1.0"
+current_version = "0.1.1"
 
 [[tool.bumpversion.files]]
 filename = "pyproject.toml"

.github/workflows/docs.yml

@@ -2,7 +2,9 @@ name: Documentation
 
 on:
   push:
-    branches: [main]
+    branches: [main, feature/release-pipeline]
+  release:
+    types: [published]
 
 permissions:
   contents: write
@@ -15,13 +17,11 @@ jobs:
         uses: actions/checkout@v4
         with:
           lfs: "true"
+          fetch-depth: 0 # fetch all commits/branches
       - name: Configure Git Credentials
         run: |
           git config user.name github-actions[bot]
           git config user.email github-actions[bot]@users.noreply.github.com
-      - uses: actions/setup-python@v4
-        with:
-          python-version: 3.11
       - name: Setup Python
         uses: actions/setup-python@v5
         with:
@@ -30,4 +30,15 @@ jobs:
       - name: Install
         run: |
           pip install ".[dev]"
-      - run: mkdocs gh-deploy --force
+      - name: Get Current Version
+        if: ${{ github.event_name == 'release' }}
+        run: |
+          export CURRENT_VERSION=$(bump-my-version show current_version)
+          echo CURRENT_VERSION=$CURRENT_VERSION >> $GITHUB_ENV
+        shell: bash
+      - name: Publish release
+        if: ${{ github.event_name == 'release' }}
+        run: mike deploy --push --update-aliases ${{ env.CURRENT_VERSION }} latest
+      - name: Publish latest
+        if: ${{ github.event_name == 'push' }}
+        run: mike deploy development --push

.github/workflows/publish.yml

@@ -0,0 +1,37 @@
+name: Publish package
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    concurrency:
+      group: publish
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          lfs: "true"
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.11
+          cache: "pip"
+      - name: Install
+        run: |
+          pip install ".[dev]"
+      - name: Get Current Version
+        run: |
+          export CURRENT_VERSION=$(bump-my-version show current_version)
+          echo CURRENT_VERSION=$CURRENT_VERSION >> $GITHUB_ENV
+        shell: bash
+      - name: Build and publish to PyPI
+        env:
+          TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+          TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+        run: |
+          python3 -m pip install --upgrade build twine
+          python3 -m build
+          python3 -m twine upload --verbose --non-interactive dist/*

CONTRIBUTING.md

@@ -150,14 +150,14 @@ This applies a simple CSS-filter to the output image of the cell.
 ## Release process
 
 In order to create a new release, make sure that the project's venv is active
-and the repository is on the main branch (including no untracked files).
+and the repository is clean and on the main branch.
 
 Create a new release using the script `build_scripts/release.sh`.
 This script will create a release tag on the repository and bump
 the version number:
 
 ```shell
-./build_scripts/release.sh 0.1.0
+./build_scripts/release.sh
 ```
 
 Afterwards, create a GitHub release for that tag. That will a trigger a CI

mkdocs.yml

@@ -37,7 +37,6 @@ plugins:
   - search
   - section-index
   - alias:
-      use_relative_link: true
       verbose: true
   - gen-files:
       scripts:
@@ -131,12 +130,11 @@ extra:
   copyright_link: https://appliedai-institute.de
   version:
     provider: mike
-    default: stable
   social:
     - icon: fontawesome/brands/github
       link: https://github.com/aai-institute/continuiti
-    # - icon: fontawesome/brands/python
-    #   link: https://pypi.org/project/continuiti/
+    - icon: fontawesome/brands/python
+      link: https://pypi.org/project/continuiti/
     - icon: fontawesome/brands/twitter
       link: https://twitter.com/appliedAI_gGmbH
     - icon: fontawesome/brands/linkedin

pyproject.toml

@@ -21,7 +21,7 @@ keywords = [
     "Artificial Intelligence", "Machine Learning", "Mathematics", "Physics",
     "Operator Learning", "Physics-Informed ML", "Neural Operator", "DeepONet",
 ]
-version = "0.1.0"
+version = "0.1.1"
 dependencies = [
     "black",            # code formatting
     "flake8",           # code analysis
@@ -77,7 +77,7 @@ dev = [
 
 [tool.setuptools.packages.find]
 where = ["src"]
-include = ["continuiti"]
+include = ["continuiti*"]
 
 [project.urls]
 Repository = "https://github.com/aai-institute/continuiti.git"