-
Notifications
You must be signed in to change notification settings - Fork 11
feat: Add GitHub Release workflow for Python SDK #46
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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,45 @@ | ||
| # .github/workflows/release-python-sdk.yml | ||
|
|
||
| name: Release Python SDK | ||
|
|
||
| # This workflow runs when a tag starting with 'sdks/python/v' is pushed | ||
| on: | ||
| push: | ||
| tags: | ||
| - 'sdks/python/v*' | ||
| workflow_dispatch: | ||
|
|
||
| permissions: | ||
| contents: write | ||
|
|
||
| jobs: | ||
| build-and-upload: | ||
| name: Build Python SDK artifact | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Set up Python | ||
| uses: actions/setup-python@v5 | ||
| with: | ||
| python-version: '3.10' | ||
|
|
||
| - name: Install build dependencies | ||
| run: pip install build twine | ||
|
|
||
| - name: Build Python wheel and source distribution | ||
| run: python3 -m build | ||
| working-directory: ./sdks/python | ||
|
|
||
| - name: Create GitHub Release and Upload Artifacts | ||
| uses: softprops/action-gh-release@v2 | ||
| with: | ||
| # This will upload all files from the build output directory | ||
| # (e.g., your-package-0.2.0-py3-none-any.whl and your-package-0.2.0.tar.gz) | ||
| files: sdks/python/dist/* | ||
| # This will create a draft release require teammate to manually publish, once | ||
| # we are confident with the release process, we can set draft: false, which | ||
| # will automatic create the release. | ||
| draft: true |
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
Oops, something went wrong.
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.
Is there a command for this?
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.
I think npm and pip support this most seamlessly, golang is more on the fetch the code directly, dotnet and java may need some workaround, they might need to download the artifact and install from local.
As of now JS and Dotnet has already been published, this exercises is trying to not avoid publishing the python test-server-sdk itself as a product.
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.
Ack. For the 'publish the release' step is there a command for this?
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.
When you click into the draft release, it looks like this

We can make the release public by clicking the publish button on the bottom.