Buildkite Package Registries command help wording fixes. #440
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
…current product name, make packages sound more like files, to make them more applicable to other package ecosystems, and correct name reference to slug.
gilesgas
requested review from
mcncl,
lizrabuya,
PriyaSudip and
jykingston
as code owners
mcncl
approved these changes
Feb 13, 2025
gilesgas
commented
Feb 13, 2025
| Use: "push registry-name {path/to/file | --stdin-file-name filename -}", | ||
| Short: "Push a new package to Buildkite Packages", | ||
| Use: "push registry-slug {path/to/file | --stdin-file-name filename -}", |
There was a problem hiding this comment.
An important change, considering slugs and names are distinctly different.
gilesgas
commented
Feb 13, 2025
| Push a new package to Buildkite Packages. The package can be passed as a path to a file in the second positional argument, | ||
| or via stdin. If passed via stdin, the filename must be provided with the --stdin-file-name flag, as Buildkite | ||
| Packages requires a filename for the package.`), | ||
| Push a new package to a Buildkite registry. The package can be passed as a path to a file in the second positional argument, |
There was a problem hiding this comment.
A "Buildkite registry" is more accurate/specific than the former product name "Buildkite Packages", and less cumbersome than referring to this type of registry as a "Buildkite Package Registries registry".
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.
Updating wording of Buildkite Package Registries commands to reflect:
Not all package ecosystems refer to their files as packages - e.g. 'modules' for Terraform, 'charts' for Helm, 'images' for 'container (Docker)', etc.