feat: implement auto-release GHA and conventional commits.

.github/workflows/black.yml

@@ -1,10 +1,9 @@
 name: Black
 
-on: [push, pull_request]
+on: [workflow_call]
 
 jobs:
   black:
-    if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
     runs-on: ubuntu-latest
 
     steps:

.github/workflows/branch.yml

@@ -0,0 +1,19 @@
+name: Check branch commit
+
+on:
+  push:
+    branches:
+      - '**'  # matches every branch ...
+      - '!main'  # ... that is not main
+
+jobs:
+  isort:
+    uses: ./.github/workflows/isort.yml
+  black:
+    uses: ./.github/workflows/black.yml
+  build:
+    uses: ./.github/workflows/build.yml
+  docs:
+    uses: ./.github/workflows/docs.yml
+  api:
+    uses: ./.github/workflows/api.yml

.github/workflows/build.yml

@@ -1,24 +1,25 @@
 name: Test BSB HDF5 engine
 
-on: [ push, pull_request ]
+on: [workflow_call]
 
 jobs:
   build:
-    if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
     runs-on: ubuntu-latest
     strategy:
       matrix:
         python-version: [ "3.9", "3.10", "3.11" ]
     steps:
       - uses: actions/checkout@v4
+
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install apt dependencies
         run: |
-          sudo apt-get update
-          sudo apt-get install openmpi-bin libopenmpi-dev
+          sudo apt update
+          sudo apt install openmpi-bin libopenmpi-dev
+
       - name: Cache pip
         uses: actions/cache@v4
         with:
@@ -27,13 +28,15 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-pip-
             ${{ runner.os }}-
+
       - name: Install dependencies & self
         run: |
-          python -m pip install --upgrade pip
-          pip install -e .[test]
-          pip install bsb-test==4.0.0rc3 --no-deps
+          # Install latest pip
+          pip install --upgrade pip
+          pip install .[test]
+
       - name: Run tests & coverage
         run: |
-          coverage run -p -m unittest
-          mpiexec -n 2 coverage run -p -m unittest
+          coverage run -p -m unittest discover -v -s ./tests
+          mpiexec -n 2 coverage run -p -m unittest discover -v -s ./tests
           bash <(curl -s https://codecov.io/bash)

.github/workflows/docs.yml

@@ -1,25 +1,24 @@
-name: docs
+name: Documentation
 
-on: [ push, pull_request ]
+on: [workflow_call]
 
 jobs:
   check-documentation:
-    if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Python 3.11
-        uses: actions/setup-python@v1
+        uses: actions/setup-python@v5
         with:
           python-version: 3.11
-      - name: Install MPI
+      - name: Setup software environment
         run: |
-          sudo apt-get update
-          sudo apt-get install -y openmpi-bin libopenmpi-dev
-      - name: Install dependencies
+          sudo apt update
+          sudo apt install -y openmpi-bin libopenmpi-dev
+      - name: Setup Python environment
         run: |
-          python -m pip install pip --upgrade
+          python -m pip install --upgrade pip
           pip install -e .[docs]
-      - name: Fail documentations on warnings
+      - name: Build documentation, nitpick, and fail on warnings
         run: cd docs && sphinx-build -nW -b html ./source ./build/html

.github/workflows/isort.yml

@@ -1,6 +1,6 @@
 name: Run isort
-on:
-  - push
+
+on: [workflow_call]
 
 jobs:
   isort:

.github/workflows/main.yml

@@ -0,0 +1,159 @@
+name: Bump version, create release and deploy
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  isort:
+    uses: ./.github/workflows/isort.yml
+  black:
+    uses: ./.github/workflows/black.yml
+  build:
+    uses: ./.github/workflows/build.yml
+  docs:
+    uses: ./.github/workflows/docs.yml
+  api:
+    uses: ./.github/workflows/api.yml
+
+  tag_release:
+    needs: [isort, black, build, docs, api]
+    runs-on: ubuntu-latest
+    outputs:
+      tag: ${{ steps.semver.outputs.next }}
+      old_tag: ${{ steps.semver.outputs.current }}
+
+    steps:
+      - name: Create Github token
+        uses: actions/create-github-app-token@v1
+        id: app-token
+        with:
+          app-id: ${{ vars.DBBS_APP_ID }}
+          private-key: ${{ secrets.DBBS_APP_PRIVATE_KEY }}
+
+      - name: Checkout Code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          token: ${{ steps.app-token.outputs.token }}
+
+      - name: Get Next Version
+        id: semver
+        uses: ietf-tools/semver-action@v1
+        with:
+          token: ${{ steps.app-token.outputs.token }}
+          branch: main
+
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.11
+
+      - name: Bump version in Python project
+        run: |
+          pip install --upgrade pip bump-my-version
+          oldv="${{ steps.semver.outputs.current }}"
+          newv="${{steps.semver.outputs.next}}"
+          # Bump the version, dropping the leading `v` with `${x:1}`
+          bump-my-version replace --current-version=${oldv:1} --new-version=${newv:1} pyproject.toml
+
+      - name: Commit & Push version change
+        uses: stefanzweifel/git-auto-commit-action@v5
+        with:
+          branch: main
+          commit_message: 'docs: bump version: ${{ steps.semver.outputs.current }} → ${{ steps.semver.outputs.next }} [skip ci]'
+
+      - name: Create tag
+        uses: rickstaa/action-create-tag@v1
+        with:
+          tag: ${{ steps.semver.outputs.next }}
+          github_token: ${{ steps.app-token.outputs.token }}
+
+  release:
+    runs-on: ubuntu-latest
+    needs: tag_release
+
+    steps:
+      - name: Create Github token
+        uses: actions/create-github-app-token@v1
+        id: app-token
+        with:
+          app-id: ${{ vars.DBBS_APP_ID }}
+          private-key: ${{ secrets.DBBS_APP_PRIVATE_KEY }}
+
+      - name: Checkout Code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          token: ${{ steps.app-token.outputs.token }}
+
+      - name: Pull commit of version change
+        run: |
+          git pull origin main 
+
+      - name: Update CHANGELOG
+        id: changelog
+        uses: requarks/changelog-action@v1
+        with:
+          token: ${{ steps.app-token.outputs.token }}
+          fromTag: ${{ needs.tag_release.outputs.tag }}
+          toTag: ${{ needs.tag_release.outputs.old_tag }}
+
+      - name: Create Release
+        uses: ncipollo/[email protected]
+        with:
+          allowUpdates: true
+          draft: false
+          makeLatest: true
+          tag: ${{ needs.tag_release.outputs.tag }}
+          name: ${{ needs.tag_release.outputs.tag }}
+          body: ${{ steps.changelog.outputs.changes }}
+          token: ${{ steps.app-token.outputs.token }}
+
+      - name: Commit CHANGELOG.md
+        uses: stefanzweifel/git-auto-commit-action@v5
+        with:
+          branch: main
+          commit_message: 'docs: update CHANGELOG.md for ${{ github.ref_name }} [skip ci]'
+          file_pattern: CHANGELOG.md
+
+  pypi-publish:
+    runs-on: ubuntu-latest
+    needs: release
+    environment:
+      name: pypi
+      url: https://pypi.org/p/bsb-hdf5
+    permissions:
+      id-token: write  # IMPORTANT: this permission is mandatory for trusted publishing
+    steps:
+      - name: Create Github token
+        uses: actions/create-github-app-token@v1
+        id: app-token
+        with:
+          app-id: ${{ vars.DBBS_APP_ID }}
+          private-key: ${{ secrets.DBBS_APP_PRIVATE_KEY }}
+
+      - name: Checkout Code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          token: ${{ steps.app-token.outputs.token }}
+
+      - name: Pull commits of version bump
+        run: |
+          git pull origin main
+
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.11
+
+      - name: Install dependencies and build dist
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+          python -m build
+
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/pull_request.yml

@@ -0,0 +1,32 @@
+name: Validate Pull Request
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, edited]
+
+jobs:
+  validate-pr-title:
+    runs-on: ubuntu-latest
+    steps:
+      - name: PR Conventional Commit Validation
+        uses:  ytanikin/[email protected]
+        with:
+          task_types: '["feat","fix","docs","test","ci","refactor","perf","revert"]'
+
+  preview-docs:
+    runs-on: ubuntu-latest
+    if: github.event.action != 'edited'
+    steps:
+      - uses: actions/checkout@v4
+      - name: Check modifications on docs
+        uses: dorny/paths-filter@v3
+        id: filter
+        with:
+          filters: |
+            docs:  # name of the filter
+              - 'docs/**'
+      - name: Preview Readthedocs
+        if: steps.filter.outputs.docs == 'true'
+        uses: readthedocs/actions/preview@v1
+        with:
+          project-slug: "bsb"

.pre-commit-config.yaml

@@ -1,3 +1,6 @@
+default_install_hook_types:
+  - pre-commit
+  - commit-msg
 repos:
   - repo: https://github.com/psf/black-pre-commit-mirror
     rev: 24.1.1
@@ -7,4 +10,11 @@ repos:
     rev: 5.12.0
     hooks:
       - id: isort
-        name: isort (python)
+        name: isort (python)
+  - repo: https://github.com/compilerla/conventional-pre-commit
+    rev: v3.3.0
+    hooks:
+      - id: conventional-pre-commit
+        name: conventional-commit
+        stages: [ commit-msg ]
+        args: [ ]

README.md

@@ -1,2 +1,9 @@
+[![Build Status](https://github.com/dbbs-lab/bsb-hdf5/actions/workflows/main.yml/badge.svg)](https://github.com/dbbs-lab/bsb-hdf5/actions/workflows/main.yml)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
 # bsb-hdf5
-The HDF5 storage engine of the BSB
+
+`bsb-hdf5` is a plugin of [BSB](https://github.com/dbbs-lab/bsb) (see also 
+[bsb-core](https://github.com/dbbs-lab/bsb-core)). 
+It contains the storage engine allowing the user to save and load their models' 
+in HDF5 files.

pyproject.toml

@@ -25,6 +25,16 @@ docs = [
     "sphinx-design~=0.5",
     "sphinx-copybutton~=0.5"
 ]
+dev  = [
+    "bsb-hdf5[test]",
+    "build~=1.0",
+    "twine~=4.0",
+    "pre-commit~=3.5",
+    "black~=24.1.1",
+    "isort~=5.12",
+    "snakeviz~=2.1",
+    "bump-my-version~=0.24"
+]
 
 [tool.isort]
 profile = "black"