-
Notifications
You must be signed in to change notification settings - Fork 172
Add PyPI Release Documentation #231
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
base: master
Are you sure you want to change the base?
Conversation
Add release trigger to workflow
Add comprehensive release documentation with shared setup steps and two release methods: manual workflow_dispatch and automated GitHub release with tags.
| Ensure your release branch has the correct version set in `ml_metadata/version.py`, then: | ||
|
|
||
| ```bash | ||
| git add . |
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.
It's better to specify to only add the intended file (ml_metadata/version.py), instead of add all.
|
|
||
| 1. Navigate to the GitHub Actions page: https://github.com/google/ml-metadata/actions | ||
| 2. Find and select the `Build ml-metadata with Conda` workflow: https://github.com/google/ml-metadata/actions/workflows/conda-build.yml | ||
| 3. Look for "This workflow has a workflow_dispatch event trigger." |
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.
This step is unnecessary, as the users can simply click on the "Run workflow" button directly.
aktech
left a comment
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 have suggested minor nitpicks, otherwise looks good.
I have tested the release process (via github release) in branch and works fine.
Description
Add comprehensive documentation for releasing ML Metadata wheels to PyPI using GitHub Actions. This includes setup instructions and two release methods:
workflow_dispatchtriggerChanges
Related Issues
Complements the token-based PyPI authentication workflow changes.