Fix authoring repo on bundle products - #4061
Open
lcawl wants to merge 1 commit into
Open
Conversation
Docs preview (local build)Handbook preview: https://docs-v3-preview.elastic.dev/elastic/docs-builder/pull/4061/ Sample changed pages: |
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
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
Fixes #4060
Details
products[].repois now the authoring GitHub repo (same resolution as the bundle filename), notproducts.ymlrepository:.Code
BundleBuilderstamps therepoargument on every product. It no longer reads the product catalog.ChangelogBundlingServicefills that argument with--repo/ profile /bundle.repo, thenGITHUB_REPOSITORY/ git origin.GetProductsByRepositoryName,repository: cloud) is unchanged.Tests and docs
BundleBuilderPerProductRepoTestsnow expect authoring repo (includingcloud-serverless+elasticsearch).BundleChangelogs_ServerlessProfile_WritesAuthoringRepoNotCatalogRepositoryuses a catalog withrepository: cloudand assertsrepo: elasticsearch.cmd-bundle.md,configure-ref.md,changelog.example.yml, and theBundleProfile.Repocomment.Tests
Related to elastic/elasticsearch#158728, I ran the following command:
docs-builder changelog bundle serverless-release 2026-09-08 "./docs/temp/Elasticsearch serverless Promotion Report.html"Before this PR, it generated a bundle that contained the following:
After this PR, it contains the correct repo name:
Generative AI disclosure
Tool(s) and model(s) used: Cursor Grok 4.6