Update Release Action for Trusted Publisher (#342)

* Update Release Action for Trusted Publisher * Update release documentation * 0.26 Release
gridstatus · Feb 27, 2024 · eabb34a · eabb34a
1 parent b5fda71
commit eabb34a
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 13 deletions.
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -2,10 +2,19 @@ on:
   release:
     types: [published]
 
-name: Release
+name: Build and Release
 jobs:
   pypi-release:
     runs-on: ubuntu-latest
+    # Uses trusted published from GitHub Actions. No need
+    # for credentials or API tokens.
+    # https://docs.pypi.org/trusted-publishers/using-a-publisher/
+    environment:
+      name: pypi
+      url: https://pypi.org/p/gridstatus
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
     steps:
     - name: Check out code
       uses: actions/checkout@v3
@@ -27,15 +36,12 @@ jobs:
           exit 1
         fi
 
-    - name: Configure Poetry for PyPI
-      run: |
-        poetry config http-basic.pypi ${{ secrets.PYPI_USERNAME }} ${{ secrets.PYPI_PASSWORD }}
-
     - name: Install dependencies
       run: poetry install
 
     - name: Build package
       run: poetry build
 
-    - name: Publish package to PyPI
-      run: poetry publish
+    # https://github.com/pypa/gh-action-pypi-publish
+    - name: Publish package distributions to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,7 +2,9 @@
 
 ## v0.26.0 - TBD
 
+- Last release supporting pandas <2
 - Add ERCOT DAM System Lambda (`ercot.get_dam_system_lambda`)
+- Add ISONE solar and wind forecasts (`isone.get_solar_forecast` and `isone.get_wind_forecast`)
 
 ## v0.25.0 - Feb 20, 2024
 

diff --git a/gridstatus/tests/test_version.py b/gridstatus/tests/test_version.py
@@ -2,4 +2,4 @@
 
 
 def test_version():
-    assert __version__ == "0.25.0"
+    assert __version__ == "0.26.0"
diff --git a/gridstatus/version.py b/gridstatus/version.py
@@ -1 +1 @@
-__version__ = "0.25.0"
+__version__ = "0.26.0"
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "gridstatus"
-version = "0.25.0"
+version = "0.26.0"
 readme = "README.md"
 description = "API to access energy data"
 classifiers = [

diff --git a/release.md b/release.md
@@ -1,8 +1,9 @@
 # How to release
 
-1. Bump version in `pyproject.toml`, `gridstatus/version.py` and `gridstatus/tests/test_version.py`
+1. Bump version in `pyproject.toml`, `gridstatus/version.py`, and `gridstatus/tests/test_version.py`
 2. Run `poetry run python ./docs/update_docs.py` to update methods in docs
-3. Run `make test-slow' to ensure slow test that CI doesn't check are passing
+3. Run `make test-slow` to ensure slow test that CI doesn't check are passing
 4. Update `CHANGELOG.md` to reflect changes made since the previous release and the date of the release
-5. Make release on GitHub and tag it with a matching version number
+5. Make release on GitHub and tag it with a matching version number. The tag must start with `v` and be followed by the version number. For example, `v0.1.0`
+  a. The `release.yaml` workflow will publish the package to PyPI after the release has been published.
 6. Confirm package was uploaded to [PyPi](https://pypi.org/project/gridstatus/)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,4 +2,4 @@


		def test_version():
		assert __version__ == "0.25.0"
		assert __version__ == "0.26.0"