Conversation
This was referenced Sep 17, 2026
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
|
||
| Upload changelog entries or bundle artifacts to S3 or Elasticsearch. The command discovers `.yaml` and `.yml` files in a local directory and uploads only files whose content hash changed since the last run. Changelog entries are uploaded once under `changelog/{org}/{repo}/{branch}/{file}`, keyed by the authoring owner, repository, and branch; bundles are uploaded under `bundle/{product}/{file}`, product-scoped from the bundle YAML. | ||
| Upload changelog entries or bundle artifacts to S3 or Elasticsearch. | ||
| The command discovers `.yaml` and `.yml` files in a local directory and by default uploads only files whose content hash changed since the last run. |
Contributor
There was a problem hiding this comment.
This sentence now overstates default behavior. With this PR, a file whose content differs from an existing remote key is not uploaded by default; it is refused unless --overwrite (or --skip-etag-check) is set.
Could you reword this line to mention both parts of the default behavior: unchanged files are skipped, and changed existing keys are refused unless overwrite is requested?
| /// <param name="skipEtagCheck">Upload every discovered file even when its content hash matches the remote object. Use to re-trigger downstream scrubbers without changing file content. Implies --overwrite.</param> | ||
| /// <param name="overwrite">Replace remote objects whose content differs. Today upload still replaces those objects even if you omit this flag. Pass it so GitHub Actions keep working after a later release that replaces only when the flag is set.</param> | ||
| /// <param name="skipEtagCheck">Upload every discovered file even when its content hash matches the remote object. Each upload emits s3:ObjectCreated, which re-triggers the scrubber Lambda on the private bucket. Default behavior (without this flag) skips unchanged files. Also replaces objects whose content differs, so you do not need --overwrite as well.</param> | ||
| /// <param name="overwrite">Replace remote objects whose content differs. Omit this flag to skip replacing those existing objects. Unchanged (ETag match) files and PR-alias markers are still skipped. Use --skip-etag-check to upload those too. When a replacement is refused, the warning includes the existing remote object.</param> |
Contributor
There was a problem hiding this comment.
This help text sounds unconditional, but the implementation can’t always include the existing remote object content. When GetObject fails, the warning falls back to a "Could not fetch ..." message.
Can we qualify this wording (for example, "when readable") so CLI help doesn’t promise remote content in every refusal case?
2 tasks
Contributor
Author
|
Reverted to simpler #4136 |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 must be merged after (1) #4075, and (2) elastic/docs-actions#346
Summary
Omitting
--overwritenow leaves a different remote object in place and exits non-zero.This change must occur only after the docs-actions have been updated to include
--overwriteso their behaviour is unchanged.Details
If-None-Match: *--overwrite), exit non-zero--overwrite--skip-etag-checkThe CLI maps
Overwrite = overwrite || skipEtagCheck.S3UploadOptionsandChangelogUploadArgumentsdefaultOverwriteto false. Docs anddocs/cli-schema.jsonsay the same thing.Tests cover default refuse,
--overwritereplace, skip-etag Put, and new-keyIf-None-Match: *.Generative AI disclosure
Tool(s) and model(s) used: Cursor Grok 4.6