Add a GitHub Action to publish the packages to PyPI or TestPyPI #1
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| name: Build and publish packages | ||
|
|
||
| on: | ||
| workflow_dispatch: | ||
| inputs: | ||
| target: | ||
| description: Where to publish the built packages | ||
| required: true | ||
| type: choice | ||
| options: | ||
| - testpypi | ||
| - pypi | ||
| default: testpypi | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| jobs: | ||
| build: | ||
| name: Build packages | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Check out repository | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Install uv | ||
| uses: astral-sh/setup-uv@v6 | ||
|
|
||
|
Collaborator
Author
There was a problem hiding this comment. Once we add some tests, we can run them as part of this workflow - and add a linting step too |
||
| - name: Build dnv_windfarmer_client | ||
| working-directory: dnv_windfarmer_client | ||
| run: uv build | ||
|
|
||
| - name: Build dnv_windfarmer_sdk | ||
| working-directory: dnv_windfarmer_sdk | ||
| run: uv build | ||
|
|
||
| - name: Upload dnv_windfarmer_client artifacts | ||
| uses: actions/upload-artifact@v4 | ||
| with: | ||
| name: dnv_windfarmer_client-dist | ||
| path: dnv_windfarmer_client/dist/ | ||
|
|
||
| - name: Upload dnv_windfarmer_sdk artifacts | ||
| uses: actions/upload-artifact@v4 | ||
| with: | ||
| name: dnv_windfarmer_sdk-dist | ||
| path: dnv_windfarmer_sdk/dist/ | ||
|
|
||
| publish: | ||
| name: Publish to ${{ github.event.inputs.target }} | ||
| needs: build | ||
| runs-on: ubuntu-latest | ||
| environment: | ||
| name: ${{ github.event.inputs.target }} | ||
| permissions: | ||
| id-token: write # required for PyPI trusted publishing | ||
|
ollymaunder-dnv marked this conversation as resolved.
|
||
| steps: | ||
| - name: Download dnv_windfarmer_client artifacts | ||
| uses: actions/download-artifact@v4 | ||
| with: | ||
| name: dnv_windfarmer_client-dist | ||
| path: dist | ||
|
|
||
| - name: Download dnv_windfarmer_sdk artifacts | ||
| uses: actions/download-artifact@v4 | ||
| with: | ||
| name: dnv_windfarmer_sdk-dist | ||
| path: dist | ||
|
|
||
| - name: Publish to TestPyPI | ||
| if: github.event.inputs.target == 'testpypi' | ||
| uses: pypa/gh-action-pypi-publish@release/v1 | ||
| with: | ||
| repository-url: https://test.pypi.org/legacy/ | ||
| packages-dir: dist | ||
|
|
||
| - name: Publish to PyPI | ||
| if: github.event.inputs.target == 'pypi' | ||
| uses: pypa/gh-action-pypi-publish@release/v1 | ||
| with: | ||
| packages-dir: dist | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Currently this is only triggered manually.
In the (near) future we can trigger it automatically. CI builds could be automatically published to Test PyPI. Tagged builds could be automatically published to the main PyPI - possibly with a manual approval step.