changelog: wire --repo/--owner and document artifact-root S3 layout#199
Open
cotti wants to merge 3 commits into
Open
changelog: wire --repo/--owner and document artifact-root S3 layout#199cotti wants to merge 3 commits into
cotti wants to merge 3 commits into
Conversation
Pass --repo/--owner to `docs-builder changelog upload` so changelog entries are
keyed by the authoring repo (changelog/{repo}/...), and update the changelog
READMEs for the new key contracts (bundle/{product}/..., changelog/{repo}/...)
and the {repo}-{dateOrVersion}.yaml bundle filename convention.
Refs elastic/docs-eng-team#413
Co-authored-by: Cursor <cursoragent@cursor.com>
|
Label error. Requires exactly 1 of: automation, breaking, bug, changelog:skip, chore, ci, dependencies, documentation, enhancement, feature, fix. Found: |
Adds a `branch` input (defaults to github.ref_name) and forwards it to
`docs-builder changelog upload` as `--branch`, so entries are uploaded under
the per-branch pool (changelog/{org}/{repo}/{branch}/...). Relaxes the upload
gate from a hard main/master check to any branch push (rejecting tags and
detached refs) and validates the branch input.
Reflects the org/branch nesting in the upload + CDN-sourcing docs:
changelog/{org}/{repo}/{branch}/{file} and registry.json, branch resolution,
and that uploads can now run from any branch (not just the default).
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.
Summary
branchinput (defaults togithub.ref_name) and forwards it todocs-builder changelog uploadas--branch, so changelog entries are uploaded under the per-branch poolchangelog/{org}/{repo}/{branch}/...of the new artifact-root layout.--owner/--repoare already passed (the org/repo segments).main/mastercheck to any branch push (tags and detached refs are still rejected), enabling changelog uploads from release/feature branches; validates thebranchinput.bundle/{product}/...,changelog/{org}/{repo}/{branch}/...) and the per-org/repo/branch entry pool used by upload and CDN sourcing.Depends on the Option AD + org/repo/branch key layout in elastic/docs-builder#3562. Refs elastic/docs-eng-team#413.
Test plan
branchinput/flag and the relaxed branch gate (env varsREPO_NAME/OWNERalready available;branchdefaults togithub.ref_name).changelog-upload/changelog-bundleworkflows run green once the docs-builder change ships on the consumed version.Made with Cursor