Merge pull request #69 from easyscience/patch

Minor updates of the tutorials

Author: AndrewSazonov

.github/release-drafter.yml

@@ -3,20 +3,25 @@
 
 name-template: 'easydiffraction $RESOLVED_VERSION'
 tag-template: 'v$RESOLVED_VERSION'
+
 categories:
   - title: 'Added'
-    labels: # Labels to use to categorize a pull request as a feature
+    labels:
       - '[scope] significant'
       - '[scope] enhancement'
-      - '[scope] documentation'
   - title: 'Fixed'
-    labels: # Labels to use to categorize a pull request as a bug fix
+    labels:
       - '[scope] bug'
   - title: 'Changed'
-    labels: # Labels to use to categorize a pull request as a maintenance task
+    labels:
       - '[scope] maintenance'
+  - title: 'Documentation'
+    labels:
+      - '[scope] documentation'
+
 change-template: '- $TITLE (#$NUMBER)'
-change-title-escapes: '\<*_&' # You can add # and @ to disable mentions, and add ` to disable code blocks.
+change-title-escapes: '\<*_&'
+
 version-resolver:
   major:
     labels:
@@ -28,7 +33,21 @@ version-resolver:
     labels:
       - '[scope] bug'
       - '[scope] maintenance'
-      - '[scope] documentation'
   default: patch
+
+# Custom logic for documentation post-releases
+# This is a workaround because Release Drafter doesn’t natively support .postN
+# We'll append .postN via the version-template below
+# - If any merged PR has the [scope] documentation label, the version becomes previous_version.postN.
+# - Increment increases for each new .postN release.
+# - If no docs label is found, normal SemVer bumping applies.
+version-template: >
+  {% if prs | selectattr("labels", "contains", "[scope] documentation") | list |
+  length > 0 %}
+    {{ previous_tag | replace("v","") }}.post{{ increment }}
+  {% else %}
+    $RESOLVED_VERSION
+  {% endif %}
+
 template: |
   $CHANGES

.github/workflows/build-docs.yml

@@ -202,7 +202,6 @@ jobs:
       # To allow the deployment of the static files to GitHub Pages, no
       # restrictions on the branch name need to be set for desired branches on
       # https://github.com/easyscience/diffraction-lib/settings/environments
-      # Currently, only develop and master branches are allowed to deploy to GitHub Pages
       # Deployed pages are available at https://easyscience.github.io/diffraction-lib
       - name:
           Deploy to easyscience.github.io/${{ github.event.repository.name }}

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

@@ -4,14 +4,22 @@
 name: Update release draft
 
 on:
-  # Runs on pushes targeting the default branch
+  # Runs on pushes targeting the default branch (updates the real draft release)
   push:
     branches:
       - main
       - master
 
+  # Runs on PRs targeting the default branch (dry-run testing; does NOT update the real draft)
+  pull_request:
+    branches:
+      - main
+      - master
+
 jobs:
   draft-release-notes:
+    if: ${{ github.event_name == 'push' }}
+
     permissions:
       # write permission is required to create a github release
       contents: write
@@ -25,3 +33,22 @@ jobs:
           disable-autolabeler: true
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  # Test the Release Drafter config on PRs without modifying the real draft release
+  draft-release-notes-dry-run:
+    if: ${{ github.event_name == 'pull_request' }}
+
+    permissions:
+      contents: read
+      pull-requests: read
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Drafts the next Release notes (dry-run)
+        uses: release-drafter/release-drafter@v6
+        with:
+          disable-autolabeler: true
+          disable-releaser: true # prevents creating/updating the draft
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/test-tutorials.yaml

@@ -69,6 +69,7 @@ jobs:
         run: |
           jupytext ${{ env.NOTEBOOKS_DIR }}/*.py --from py:percent --to ipynb
           nbstripout ${{ env.NOTEBOOKS_DIR }}/*.ipynb
+          python tools/prepare_notebooks.py ${{ env.NOTEBOOKS_DIR }}/
 
       - name: Check Jupyter notebooks formatting
         id: check_notebooks