Merge pull request #68 from easyscience/patch

Fixes the CI workflow

Author: AndrewSazonov

.github/workflows/build-docs.yml

@@ -5,6 +5,9 @@ on:
   push:
     # Selected branches
     branches: [develop, master, docs, patch]
+    # Runs on creating a new tag starting with 'v', e.g. 'v1.0.3'
+    tags:
+      - 'v*'
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
 
@@ -160,10 +163,10 @@ jobs:
           path: site/
 
       # Upload the static files from the site/ directory to be used in the next job
-      # This extra step is needed to allow the download of the artifact in the next job
-      # for pushing its content to the branch named 'gh_pages'
-      - name: Upload built site as artifact for gh_pages (master branch)
-        if: ${{ env.CI_BRANCH == 'master' }}
+      # This artifact is only uploaded on tagged releases (tags starting with 'v', e.g., v1.0.3)
+      # and is used to push content to gh_pages for custom domain deployment.
+      - name: Upload built site as artifact for gh_pages (tagged release)
+        if: startsWith(github.ref, 'refs/tags/v')
         uses: actions/upload-artifact@v4
         with:
           name: artifact # name of the artifact (without the extension zip)
@@ -206,26 +209,30 @@ jobs:
           (all branches)
         uses: actions/deploy-pages@v4
 
-      # Download built site as artifact from a previous job for gh_pages (master branch)
-      - name: Download built site from previous job (master branch)
-        if: ${{ env.CI_BRANCH == 'master' }}
+      # Download built site as artifact from a previous job for gh_pages (tagged release)
+      # This artifact is only downloaded on tagged releases (tags starting with 'v', e.g., v1.0.3)
+      # and is used to push content to gh_pages for custom domain deployment.
+      - name: Download built site from previous job (tagged release)
+        if: startsWith(github.ref, 'refs/tags/v')
         uses: actions/download-artifact@v4
         with: # name or path are taken from the upload step of the previous job
           name: artifact
           path: site/ # directory to extract downloaded zipped artifacts
 
       # Push the site files created in the previous job to the gh_pages branch
+      # This push happens only for tagged releases (tags starting with 'v'),
+      # which triggers deployment to the custom domain via webhook.
+      #
       # To be able to push to the gh_pages branch, the personal GitHub API access
       # token GH_API_PERSONAL_ACCSESS_TOKEN must be set for this repository via
       # https://github.com/easyscience/diffraction-lib/settings/secrets/actions
-      # This branch is used to deploy the site to the custom domain.
-      # Deploying is done with a webhook:
+      # Then the gh_pages branch is used to deploy the site to the custom domain.
+      # Deploying is done with a webhook added via:
       # https://github.com/easyscience/diffraction-lib/settings/hooks
-      # This is done for the gh_pages branch when the site is tested with a step above
       - name:
           Deploy to gh_pages branch to trigger deployment to custom domain
-          (master branch)
-        if: ${{ env.CI_BRANCH == 'master' }}
+          (tagged release)
+        if: startsWith(github.ref, 'refs/tags/v')
         uses: s0/git-publish-subdir-action@develop
         env:
           GITHUB_TOKEN: ${{ secrets.GH_API_PERSONAL_ACCSESS_TOKEN }}

.github/workflows/draft-release-notes.yml

@@ -0,0 +1,27 @@
+# Drafts your next Release notes as pull requests are merged into
+# default branch
+
+name: Update release draft
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches:
+      - main
+      - master
+
+jobs:
+  draft-release-notes:
+    permissions:
+      # write permission is required to create a github release
+      contents: write
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Drafts the next Release notes
+        uses: release-drafter/release-drafter@v6
+        with:
+          disable-autolabeler: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}