Finalise environments targets and documentation #17095
Merged
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
added 11 commits
October 3, 2022 13:13
[ci skip-rust]
# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust]
# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]
# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]
# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]
# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]
# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]
# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust]
# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust]
# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]
# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]
chrisjrn
changed the title
chrisjrn
added
the
category:internal
chrisjrn
requested review from
stuhood and
Eric-Arellano
and removed request for
stuhood
# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]
# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]
Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
chrisjrn
commented
Oct 4, 2022
| registries. | ||
| This value may be any image identifier that the local Docker installation can accept. | ||
| This includes image names with or without tags (e.g. `centos6` or `centos6:latest`), or | ||
| image names with an immutable digest (e.g. `centos@sha256:<some_sha256_value>`). |
There was a problem hiding this comment.
I didn't specify an actual sha256 value here, as I think these docs are probably going to be subject to bitrot (basically preserving bugs or vulnerabilities that are out of our control within our docs). I imagine people familiar with Docker will be able to figure out what a good value here would be.
Eric-Arellano
approved these changes
Oct 4, 2022
Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
stuhood
approved these changes
Oct 4, 2022
Comment on lines
+155
to
+157
| Only one `local_environment` may be defined in `[environments-preview].names` per platform, and | ||
| when `{LOCAL_ENVIRONMENT_MATCHER}` is specified as the environment, the | ||
| `local_environment` that matches the current platform (if defined) will be selected. |
There was a problem hiding this comment.
All of the environment targets should include a doc URL for #17096 in their help: but if you're planning on landing this today, we can do that in a followup.
|
|
||
| TODO: expectations about what are valid IDs, e.g. if they must come from DockerHub vs other | ||
| registries. | ||
| This value may be any image identifier that the local Docker installation can accept. |
There was a problem hiding this comment.
Should possibly remind users to use a SHA for reproducibility?
Comment on lines
+243
to
+245
| Configuration of a Docker environment used for building your code, including the Docker | ||
| image, along with environment-sensitive options, which include environment variables and | ||
| search paths, used by Pants to execute processes in this Docker environment. |
There was a problem hiding this comment.
This sentence has too many commas in it I think: not sure how to fix that. Break it up until multiple sentences, or make part of it parenthetical maybe?
Comment on lines
305
to
+307
| Configuration of a remote execution environment used for building your code, including the | ||
| environment variables and search paths used by Pants. | ||
| environment-sensitive options, which include environment variables and | ||
| search paths, used by Pants to execute processes in this remote environment. |
chrisjrn
pushed a commit
that referenced
this pull request
Oct 7, 2022
Adds documentation requested in #17095, and also renames the `_environment` field to `environment`.
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 prepares the runtime environments support for preview release as part of 2.15:
_local,_docker, and_remote}_environmentare now marked publicenvironments-previewsubsystem and_environmentfield name remains as indicating preview status.Closes #7735