Add documentation about the CI system #6925
Open
Conversation
This file contains 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
briron
reviewed
Oct 4, 2024
|
|
||
| ### Releases | ||
|
|
||
| When a release is made on GitHub the workflow that builds wheels runs, just as |
There was a problem hiding this comment.
Does the release process also cover the image upload in Docker or GCP AR?
There was a problem hiding this comment.
No, the other stuff that isn't related to building python wheels isn't included. The docker image is as far as I can tell just a tool for making an environment in which the tfx wheels can be built. Is that right?
If so, I'd caution against becoming overreliant on docker images for building wheels. I've seen cases (notably other TF-adjacent packages) which can only be built inside certain docker images, which makes library development very cumbersome; pip install -e . becomes impossible if the only way to build the project is inside a container.
smokestacklightnin
requested changes
Oct 4, 2024
Co-authored-by: William Black <125844868+smokestacklightnin@users.noreply.github.com>
Co-authored-by: William Black <125844868+smokestacklightnin@users.noreply.github.com>
smokestacklightnin
approved these changes
Oct 4, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR adds a bit of documentation to
CONTRIBUTING.mdabout what the CI system does. There's a description of the events which trigger workflows, and the needs the workflows fulfill.