Add PyPI Release Documentation #231
Open
Conversation
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
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.
aktech
reviewed
Jan 29, 2026
| Ensure your release branch has the correct version set in `ml_metadata/version.py`, then: | ||
|
|
||
| ```bash | ||
| git add . |
Collaborator
There was a problem hiding this comment.
It's better to specify to only add the intended file (ml_metadata/version.py), instead of add all.
aktech
reviewed
Jan 29, 2026
|
|
||
| 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." |
Collaborator
There was a problem hiding this comment.
This step is unnecessary, as the users can simply click on the "Run workflow" button directly.
aktech
reviewed
Jan 29, 2026
Collaborator
aktech
left a comment
aktech
left a comment
There was a problem hiding this comment.
I have suggested minor nitpicks, otherwise looks good.
I have tested the release process (via github release) in branch and works fine.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
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.