Merge pull request #160 from EasyScience/develop

New release

Author: AndrewSazonov

.github/release-drafter.yml

@@ -1,32 +1,35 @@
+# This file is used to configure the Release Drafter GitHub Action
 # https://github.com/marketplace/actions/release-drafter
-name-template: v$NEXT_PATCH_VERSION 🌈
-tag-template: v$NEXT_PATCH_VERSION
+
+name-template: 'EasyDiffraction $RESOLVED_VERSION'
+tag-template: 'v$RESOLVED_VERSION'
 categories:
-- title: 🚀 Features
-  labels:
-  - feature
-  - enhancement
-- title: 🐛 Bug Fixes
-  labels:
-  - fix
-  - bugfix
-  - bug
-- title: 🧰 Maintenance
-  labels:
-  - chore
-  - documentation
-change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
+- title: 'Added'
+  labels:  # Labels to use to categorize a pull request as a feature
+    - 'enhancement'
+- title: 'Fixed'
+  labels:  # Labels to use to categorize a pull request as a bug fix
+    - 'bug'
+- title: 'Changed'
+  labels:  # Labels to use to categorize a pull request as a maintenance task
+    - 'chore'
+    - 'documentation'
+    - 'refactor'
+change-template: '- $TITLE (#$NUMBER)'
+change-title-escapes: '\<*_&' # You can add # and @ to disable mentions, and add ` to disable code blocks.
 version-resolver:
   major:
     labels:
-    - major
+      - 'major'
   minor:
     labels:
-    - minor
+      - 'enhancement'
   patch:
     labels:
-    - patch
+      - 'bug'
+      - 'chore'
+      - 'documentation'
+      - 'refactor'
   default: patch
 template: |
-  ## Changes
   $CHANGES

.github/workflows/delete-old-runs.yml

@@ -1,4 +1,5 @@
-# This workflow will delete old workflow runs based on the input parameters.
+# This workflow will delete old workflow runs based on the input
+# parameters.
 # https://github.com/Mattraks/delete-workflow-runs
 
 name: Delete old workflow runs

.github/workflows/ossar-analysis.yml

@@ -1,4 +1,5 @@
-# Integrates a collection of open source static analysis tools with GitHub code scanning.
+# Integrates a collection of open source static analysis tools with
+# GitHub code scanning.
 # https://github.com/github/ossar-action
 
 name: Run security static analysis

.github/workflows/pypi-publish.yml

@@ -1,4 +1,5 @@
-# Builds a Python package and publish it to PyPI when a new tag is created.
+# Builds a Python package and publish it to PyPI when a new tag is
+# created.
 
 name: Upload release to PyPI
 
@@ -19,6 +20,8 @@ jobs:
     steps:
     - name: Check-out repository
       uses: actions/checkout@v4
+      with:
+        fetch-depth: '0'  # full history with tags to get the version number by versioningit
 
     - name: Set up Python
       uses: actions/setup-python@v5

.github/workflows/release-drafter.yml

@@ -1,4 +1,5 @@
-# Drafts your next Release notes as pull requests are merged into default branch
+# Drafts your next Release notes as pull requests are merged into
+# default branch
 
 name: Update release draft
 
@@ -14,7 +15,7 @@ jobs:
 
     steps:
       - uses: release-drafter/release-drafter@v6
-        id: create_release
+        id: create-release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
@@ -31,7 +32,7 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
-          upload_url: ${{ steps.create_release.outputs.upload_url }} # This pulls from the create_release step above
+          upload_url: ${{ steps.create-release.outputs.upload_url }} # This pulls from the create-release step above
           asset_path: ./examples.zip
           asset_name: examples.zip
           asset_content_type: application/zip

.github/workflows/test-code.yaml

@@ -44,6 +44,8 @@ jobs:
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
+        with:
+          fetch-depth: '0'  # full history with tags to get the version number by versioningit
 
       - name: Set up Python
         uses: actions/setup-python@v5
@@ -83,6 +85,8 @@ jobs:
     steps:
     - name: Checkout repository
       uses: actions/checkout@v4
+      with:
+        fetch-depth: '0'  # full history with tags to get the version number by versioningit
 
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v5

.github/workflows/test-ipynb.yml

@@ -34,6 +34,8 @@ jobs:
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
+        with:
+          fetch-depth: '0'  # full history with tags to get the version number by versioningit
 
       - name: Set up Python
         uses: actions/setup-python@v5
@@ -69,6 +71,8 @@ jobs:
     steps:
       - name: Check-out repository
         uses: actions/checkout@v4
+        with:
+          fetch-depth: '0'  # full history with tags to get the version number by versioningit
 
       - name: Set up Python environment
         uses: actions/setup-python@v5

.github/workflows/test-package.yaml

@@ -51,6 +51,8 @@ jobs:
     steps:
     - name: Checkout repository
       uses: actions/checkout@v4
+      with:
+        fetch-depth: '0'  # full history with tags to get the version number by versioningit
 
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v5
@@ -104,6 +106,10 @@ jobs:
         name: EasyDiffractionLib_py${{ matrix.python-version }}_${{ matrix.os }}_${{ runner.arch }}
         path: .  # directory to extract downloaded zipped artifacts
 
+    # The local version must be higher than the PyPI version for pip to
+    # prefer the local version. So, after a new release and a new tag,
+    # remember to merge the master branch with the develop branch,
+    # and then create a new feature branch from the develop branch.
     - name: Install Python package from previous job with 'dev' extras
       run: pip install 'easydiffraction[dev]' --find-links=dist
 
@@ -117,7 +123,7 @@ jobs:
       shell: bash
       run: >
         pytest 
-        --nbmake examples 
+        --nbmake examples/
         --ignore-glob='examples/*emcee*'
         --nbmake-timeout=300 
         --color=yes

.github/workflows/verify-pr-labels.yml

@@ -1,4 +1,5 @@
-# Verifies if a pull request has at least one label from a set of valid labels before it can be merged.
+# Verifies if a pull request has at least one label from a set of valid
+# labels before it can be merged.
 
 name: Verify pull request labels
 
@@ -18,6 +19,6 @@ jobs:
       uses: jesusvasquez333/[email protected]
       with:
         github-token: ${{ secrets.GITHUB_TOKEN }}
-        valid-labels: chore, fix, bugfix, bug, enhancement, feature, dependencies, documentation
+        valid-labels: 'enhancement, bug, chore, documentation, refactor'
         pull-request-number: ${{ github.event.pull_request.number }}
         disable-reviews: false

DEVELOPMENT.md

@@ -1,6 +1,6 @@
 # Development
 
-This is an example of a workflow that describes the development process. 
+This is an example of a workflow that describes the development process.
 
 * Clone EasyDiffractionLib repository
   ```console
@@ -27,18 +27,19 @@ This is an example of a workflow that describes the development process.
   ```console
   python -m pip install --upgrade pip
   ```
-* Install easydiffraction from root with `dev` extras for development 
+* Install easydiffraction from root with `dev` extras for development
   ```console
   pip install '.[dev]'
   ```
 * Make changes in the code
 * Run Ruff - Python linter and code formatter (configuration is in pyproject.toml)
   ```console
-  ruff check . --fix 
+  ruff check --fix  # Linting (overwriting files)
+  ruff format       # Formatting (overwriting files)
   ```
 * Run python tests
   ```console
-  pytest tests/ --color=yes -n auto 
+  pytest tests/ --color=yes -n auto
   ```
 * Clear all Jupyter notebooks output
   ```console