Skip to content

Edit changelog bundle docs#3213

Open
lcawl wants to merge 10 commits intomainfrom
changelog-edits2
Open

Edit changelog bundle docs#3213
lcawl wants to merge 10 commits intomainfrom
changelog-edits2

Conversation

@lcawl
Copy link
Copy Markdown
Contributor

@lcawl lcawl commented Apr 30, 2026

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.

@lcawl lcawl added the documentation Improvements or additions to documentation label Apr 30, 2026
@lcawl lcawl mentioned this pull request Apr 30, 2026
5 tasks
@lcawl lcawl marked this pull request as ready for review May 5, 2026 23:03
@lcawl lcawl requested review from a team as code owners May 5, 2026 23:03
@lcawl lcawl requested a review from cotti May 5, 2026 23:03
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 5, 2026

Caution

Review failed

Failed to post review comments

📝 Walkthrough

Walkthrough

This 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)
Loading
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately captures the main objective of the PR: editing documentation related to changelog bundle functionality across multiple files.
Description check ✅ Passed The description clearly explains the purpose of the PR: reorganizing bundle-related documentation to separate simplest paths (profiles) from advanced variations, with a reference to the related issue.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch changelog-edits2

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between b31505c and 62c61f7.

📒 Files selected for processing (10)
  • config/changelog.example.yml
  • docs/cli/changelog/add.md
  • docs/cli/changelog/bundle.md
  • docs/cli/changelog/gh-release.md
  • docs/cli/changelog/remove.md
  • docs/contribute/bundle-changelogs.md
  • docs/contribute/configure-changelogs-ref.md
  • docs/contribute/configure-changelogs.md
  • docs/contribute/create-changelogs.md
  • docs/syntax/changelog.md

Comment thread config/changelog.example.yml Outdated
Comment thread docs/contribute/bundle-changelogs.md Outdated
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@lcawl lcawl enabled auto-merge (squash) May 6, 2026 15:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants