Conversation
|
Caution Review failedFailed to post review comments 📝 WalkthroughWalkthroughThis pull request updates and expands changelog documentation. It redirects configuration links to the new configure-changelogs-ref.md, adds and documents new bundle CLI options (hide-features, input-products, output-products, release-version, report), reorganizes bundle configuration reference with bundle descriptions and profiles, consolidates removal workflows, and adds rules- and GitHub Actions–related guidance. All edits are documentation-only; no functional code changes. Sequence Diagram(s)sequenceDiagram
participant User as User
participant CLI as docs-builder CLI
participant Config as Changelog Config
participant GitHub as GitHub API / Release
participant Rules as Rules Engine
participant Renderer as Bundle Renderer
participant Out as Output (bundle / files)
User->>CLI: run `changelog bundle` with options (--input-products, --release-version, --report, --hide-features, --output-products)
CLI->>Config: load bundle config & profiles
CLI->>GitHub: fetch releases / PRs (if GitHub-based or --report)
GitHub-->>CLI: return PRs / release notes
CLI->>Rules: collect changelog files (filtered by --input-products) and apply rules.bundle (include/exclude, per-product overrides)
Rules-->>CLI: filtered changelog entries
CLI->>Renderer: pass entries + hide-features (config + CLI) + release/version metadata
Renderer-->>Out: render bundled changelog files (comments out hidden features, writes outputs)
Out-->>User: generated bundle and metadata (e.g., changelog-bundle.yaml)
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches✨ Simplify code
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@config/changelog.example.yml`:
- Line 154: The documentation URL in the comment contains a duplicate path
segment ("contribute/contribute/configure-changelogs-ref"); update the URL
string to use the correct path "contribute/configure-changelogs-ref.md" so the
link points to the intended reference (replace the existing URL in the comment
that currently reads
"https://github.com/elastic/docs-builder/blob/main/docs/contribute/contribute/configure-changelogs-ref"
with
"https://github.com/elastic/docs-builder/blob/main/docs/contribute/configure-changelogs-ref.md").
In `@docs/contribute/bundle-changelogs.md`:
- Line 430: Replace the typo "visibiblity" with the correct spelling
"visibility" in the sentence that reads "If you are working in a private repo
and do not want any pull request or issue links to appear (even if they target a
public repo), you can also configure link visibiblity in the [changelog
directive](/syntax/changelog.md#hide-links) and [changelog
render](/cli/changelog/render.md) command." by editing that exact phrase ("link
visibiblity") to "link visibility" so the references to [changelog directive]
and [changelog render] remain unchanged.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 87656266-9ca6-4148-a2f8-c3e2620f167c
📒 Files selected for processing (10)
config/changelog.example.ymldocs/cli/changelog/add.mddocs/cli/changelog/bundle.mddocs/cli/changelog/gh-release.mddocs/cli/changelog/remove.mddocs/contribute/bundle-changelogs.mddocs/contribute/configure-changelogs-ref.mddocs/contribute/configure-changelogs.mddocs/contribute/create-changelogs.mddocs/syntax/changelog.md
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Relates to #3050
This PR cleans up the docs related to the creating bundles.
The goal is for the how-to page (https://elastic.github.io/docs-builder/contribute/bundle-changelogs/) to cover the simplest path (i.e. profiles) and for the reference page (https://elastic.github.io/docs-builder/cli/changelog/bundle/ and others) to cover all the variations and advanced details.