Register playground release-notes repos in assembler.yml scrubber allowlist - #3980
Merged
Conversation
…owlist Both repos stay private (IT approval needed to make them public), so they get `private: true`. The scrubber allowlist controls which repo links survive sanitisation in the public CDN bucket — without these entries, PR links in bundled release notes would be rewritten to PRIVATE: sentinels. Co-Authored-By: Claude <noreply@anthropic.com>
Docs preview (local build)Handbook preview: https://docs-v3-preview.elastic.dev/elastic/docs-builder/pull/3980/ |
`AssemblyConfiguration.PrivateRepositories` is populated before `--skip-private-repositories` removes private entries, and `AssemblerCrossLinkFetcher` concatenates those repos back in to fetch their cross-links. Without `skip: true`, both entries failed the assembler `build` and `validate-assembler` CI checks with: Repository docs-playground-release-notes-changelogs not found in link index The established shape for a repo listed for changelog link-visibility only (no docs site) is `private: true` + `skip: true` — matching the ten existing team repos (`kibana-team`, `search-team`, etc.) and documented in `LinkAllowlistSanitizer.BuildAllowReposFromAssembler`. While both repos are private the allowlist entries are a behavioural no-op: `BuildAllowReposFromAssembler` skips anything `Private`, so published output is unchanged. The SHA baked into the changelog-scrubber Lambda will mismatch until the next release redeploys it; that is expected and not a regression. Co-Authored-By: Claude <noreply@anthropic.com>
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.
Adds
docs-playground-release-notes-changelogsanddocs-playground-release-notes-taggedtoconfig/assembler.ymlso PR and issue links in their bundled release notes survive the changelog scrubber. Both repos stayprivate: true(making them public requires IT approval).Affects: Release notes
Why
The changelog scrubber Lambda uses
assembler.ymlas its allowlist of repos whose links are permitted in the public CDN bucket. Without these entries, any PR link in a published bundle would be rewritten to aPRIVATE:sentinel. The repos are private, so only link metadata is scrubbed — no doc content is assembled from them.Risk:
config/assembler.ymlis baked into the changelog-scrubber Lambda as its allowlist at build time. The deployed Lambda picks up the new allowlist on the next Lambda release after this merges.Stack: 2 of 2, follow-on to #3978.