Merge pull request #118 from mrakitin/rel-notes-v0.6.2

DOC: release notes for v0.6.2
NSLS-II · Jun 9, 2023 · 82872f0 · 82872f0
2 parents 211a651 + d1e1a85
commit 82872f0
Show file tree

Hide file tree

Showing 10 changed files with 62 additions and 470 deletions.
diff --git a/.github/workflows/publish-pypi.yml b/.github/workflows/publish-pypi.yml
@@ -1,6 +1,7 @@
-# This workflow will upload a Python Package using flit when a release is
-# created.  For more information see:
-# https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+# This workflows will upload a Python Package when a release is created.
+# For more information see:
+# - https://docs.pypi.org/trusted-publishers/adding-a-publisher/
+# - https://github.com/pypa/gh-action-pypi-publish
 
 name: PyPI upload
 
@@ -12,28 +13,27 @@ jobs:
   publish_pypi:
     name: Publish package to PyPI
     runs-on: ubuntu-latest
+    permissions:
+      id-token: write
 
     steps:
-    - uses: actions/checkout@v3
-      with:
-        fetch-depth: 0
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
 
-    - name: Set up Python
-      uses: actions/setup-python@v4
-      with:
-        python-version: '3.x'
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
 
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install wheel twine setuptools
+      - name: Build package
+        run: |
+          set -vxeuo pipefail
+          python -m pip install --upgrade pip
+          pip install wheel setuptools
+          python setup.py sdist bdist_wheel
 
-    - name: Build and publish
-      env:
-        TWINE_USERNAME: __token__
-        # The PYPI_PASSWORD must be a pypi token with the "pypi-" prefix with sufficient permissions to upload this package
-        # https://pypi.org/help/#apitoken
-        TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
-      run: |
-        python setup.py sdist bdist_wheel
-        twine upload dist/*
+      - name: Publish wheels to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: ./dist/
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -8,7 +8,7 @@ repos:
       - id: end-of-file-fixer
       - id: trailing-whitespace
   - repo: https://github.com/ambv/black
-    rev: 23.1.0
+    rev: 23.3.0
     hooks:
       - id: black
   - repo: https://github.com/pycqa/flake8

diff --git a/docs/source/notebooks-new-api.rst → docs/source/examples.rst b/docs/source/notebooks-new-api.rst → docs/source/examples.rst
@@ -1,5 +1,5 @@
-Notebooks (new API)
-===================
+Examples
+========
 
 .. toctree::
    :maxdepth: 2

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -10,7 +10,6 @@ sirepo-bluesky Documentation
    :maxdepth: 2
 
    installation
-   notebooks-old-api
-   notebooks-new-api
+   examples
    simulations
    release-history
diff --git a/docs/source/notebooks-old-api.rst b/docs/source/notebooks-old-api.rst
diff --git a/docs/source/notebooks/shadow.ipynb b/docs/source/notebooks/shadow.ipynb