Use CasperWA/gh-actions workflows (#60)

Use CasperWA/gh-actions workflows.

This implements the use of the currently available workflows
in the external repository for:

- Releasing package to PyPI and deploy documentation
- Check and update dependencies in `pyproject.toml`

The dependency update workflow has been tested and is
considered properly implemented and working at this point.

The release workflow still needs to be tested with a proper release.
Then it should be updated, setting `test` to `false`, and probably
tested again.

Author: CasperWA

.github/utils/pyproject_toml_update_pr_body.txt

@@ -5,126 +5,22 @@ on:
     types:
     - published
 
-env:
-  PUBLISH_UPDATE_BRANCH: main
-  GIT_USER_NAME: "TEAM 4.0[bot]"
-  GIT_USER_EMAIL: "Team4.0@SINTEF.no"
-
 jobs:
-  update-and-publish:
-    name: Update CHANGELOG and version and publish to PyPI
-    runs-on: ubuntu-latest
+  publish-package-and-docs:
+    name: Call external workflow
+    uses: CasperWA/gh-actions/.github/workflows/cd_release.yml@main
     if: github.repository == 'SINTEF/oteapi-optimade' && startsWith(github.ref, 'refs/tags/v')
-
-    steps:
-    - name: Checkout repository
-      uses: actions/checkout@v3
-      with:
-        fetch-depth: 0
-
-    - name: Set up Python 3.9
-      uses: actions/setup-python@v4
-      with:
-        python-version: "3.9"
-
-    - name: Install Python dependencies
-      run: |
-        python -m pip install -U pip
-        pip install -U setuptools wheel flit
-        pip install -U -e .[dev]
-
-    - name: Update changelog
-      uses: CharMixer/auto-changelog-action@v1
-      with:
-        token: ${{ secrets.GITHUB_TOKEN }}
-        release_branch: ${{ env.PUBLISH_UPDATE_BRANCH }}
-
-    - name: Set up git user
-      run: |
-        git config --global user.name "${GIT_USER_NAME}"
-        git config --global user.email "${GIT_USER_EMAIL}"
-
-    - name: Update version and tag
-      run: |
-        invoke setver --version="${GITHUB_REF#refs/tags/}"
-
-        git add oteapi_optimade/__init__.py tests/static/test_optimade_config.yml CHANGELOG.md
-        git commit -m "Release ${GITHUB_REF#refs/tags/} - Changelog"
-
-        TAG_MSG=.github/utils/release_tag_msg.txt
-        sed -i "s|TAG_NAME|${GITHUB_REF#refs/tags/}|" "${TAG_MSG}"
-        git tag -af -F "${TAG_MSG}" ${GITHUB_REF#refs/tags/}
-
-    - name: Build source distribution
-      run: |
-        # First, clean the git tree
-        git checkout -- .
-        flit build
-
-    - name: Update '${{ env.PUBLISH_UPDATE_BRANCH }}'
-      uses: CasperWA/push-protected@v2
-      with:
-        token: ${{ secrets.RELEASE_PAT }}
-        branch: ${{ env.PUBLISH_UPDATE_BRANCH }}
-        sleep: 15
-        force: true
-        tags: true
-        unprotect_reviews: true
-
-    - name: Get tagged versions
-      run: echo "PREVIOUS_VERSION=$(git tag -l --sort -version:refname | sed -n 2p)" >> $GITHUB_ENV
-
-    - name: Create release-specific changelog
-      uses: CharMixer/auto-changelog-action@v1
-      with:
-        token: ${{ secrets.GITHUB_TOKEN }}
-        release_branch: ${{ env.PUBLISH_UPDATE_BRANCH }}
-        since_tag: "${{ env.PREVIOUS_VERSION }}"
-        output: "release_changelog.md"
-
-    - name: Append changelog to release body
-      run: |
-        gh api /repos/${{ github.repository }}/releases/${{ github.event.release.id }} --jq '.body' > release_body.md
-        cat release_changelog.md >> release_body.md
-        gh api /repos/${{ github.repository }}/releases/${{ github.event.release.id }} -X PATCH -F body='@release_body.md'
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
-    - name: Publish package to PyPI
-      uses: pypa/gh-action-pypi-publish@v1.5.0
-      with:
-        user: __token__
-        password: ${{ secrets.PYPI_TOKEN }}
-
-  docs:
-    name: Deploy release documentation
-    needs: update-and-publish
-    runs-on: ubuntu-latest
-
-    steps:
-    - name: Checkout repository
-      uses: actions/checkout@v3
-      with:
-        fetch-depth: 0
-        ref: ${{ env.PUBLISH_UPDATE_BRANCH }}
-
-    - name: Set up Python 3.9
-      uses: actions/setup-python@v4
-      with:
-        python-version: "3.9"
-
-    - name: Install Python dependencies
-      run: |
-        python -m pip install -U pip
-        pip install -U setuptools wheel flit
-        pip install -U -e .[doc]
-
-    - name: Set up git user
-      run: |
-        git config --global user.name "${{ env.GIT_USER_NAME }}"
-        git config --global user.email "${{ env.GIT_USER_EMAIL }}"
-
-    - name: Deploy documentation
-      run: |
-        mike deploy --push --remote origin --branch gh-pages --update-aliases --config-file mkdocs.yml ${GITHUB_REF#refs/tags/v} stable
-        mike deploy --push --remote origin --branch gh-pages --update-aliases --config-file mkdocs.yml latest ${{ env.PUBLISH_UPDATE_BRANCH }}
+    with:
+      package_dir: oteapi_optimade
+      git_username: "TEAM 4.0[bot]"
+      git_email: "Team4.0@SINTEF.no"
+      release_branch: main
+      install_extras: "[dev]"
+      python_version: "3.9"
+      update_docs: true
+      doc_extras: "[doc]"
+      build_cmd: "pip install -U flit && flit build"
+      test: true
+    secrets:
+      PyPI_token: ${{ secrets.TESTPYPI_TOKEN }}
+      release_PAT: ${{ secrets.RELEASE_PAT }}

.github/utils/release_tag_msg.txt

@@ -0,0 +1,22 @@
+name: CI - Check dependencies
+
+on:
+  schedule:
+    # At 7:30 every Monday (5:30 UTC)
+    - cron: "30 5 * * 1"
+  workflow_dispatch:
+
+jobs:
+  check-dependencies:
+    name: Call external workflow
+    uses: CasperWA/gh-actions/.github/workflows/ci_check_pyproject_dependencies.yml@main
+    if: github.repository_owner == 'SINTEF'
+    with:
+      git_username: "TEAM 4.0[bot]"
+      git_email: "Team4.0@SINTEF.no"
+      permanent_dependencies_branch: "ci/dependency-updates"
+      python_version: "3.9"
+      install_extras: "[dev]"
+      pr_labels: "CI/CD"
+    secrets:
+      release_PAT: ${{ secrets.RELEASE_PAT }}