Merge pull request #38 from NSLS-II/rel-notes-v0.3.0

DOC: release notes for v0.3.0
NSLS-II · Jun 17, 2023 · e81304e · e81304e
2 parents 5ef478b + d62fc0b
commit e81304e
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 23 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/docs/source/release-history.rst b/docs/source/release-history.rst
@@ -2,6 +2,13 @@
 Release History
 ===============
 
+v0.3.0 (2023-06-17)
+-------------------
+
+- Implemented multi-task optimization
+- Simplified the syntax on initializing the agent
+- Resolved issues discovered at ISS
+
 
 v0.2.0 (2023-04-25)
 -------------------