Skip to content

Fix changelog bundle examples#3359

Open
lcawl wants to merge 2 commits into
mainfrom
changelog-bundle-docs
Open

Fix changelog bundle examples#3359
lcawl wants to merge 2 commits into
mainfrom
changelog-bundle-docs

Conversation

@lcawl
Copy link
Copy Markdown
Contributor

@lcawl lcawl commented May 20, 2026

This PR cleans up some examples in https://elastic.github.io/docs-builder/contribute/bundle-changelogs/ and https://elastic.github.io/docs-builder/cli/changelog/bundle/ that seemed to be moved or lost in #3221

The how-to page focuses only on the simplest method (profile-based commands), so I've moved the option-based commands back to the command reference page.

@lcawl lcawl requested review from a team as code owners May 20, 2026 00:49
@lcawl lcawl requested a review from reakaleek May 20, 2026 00:49
@lcawl lcawl added the documentation Improvements or additions to documentation label May 20, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 20, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 26e5cec8-11f2-4cda-9210-201d6f34f423

📥 Commits

Reviewing files that changed from the base of the PR and between 3575023 and cb0dcf5.

📒 Files selected for processing (1)
  • docs/cli/changelog/cmd-bundle.md
✅ Files skipped from review due to trivial changes (1)
  • docs/cli/changelog/cmd-bundle.md

📝 Walkthrough

Walkthrough

This PR enhances changelog bundle documentation across two files. docs/cli/changelog/cmd-bundle.md adds an Examples section with six subsections covering bundling by GitHub release tags, issues, PRs (with sample bundle YAML), product filters (with wildcards), buildkite promotion reports, and hide-features behavior. docs/contribute/bundle-changelogs.md clarifies promotion report examples, removes obsolete cloud-serverless guidance, and tightens link_allow_repos rules to require explicit repository listing.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: fixing/reorganizing changelog bundle examples across two documentation pages by restoring and relocating content.
Description check ✅ Passed The description clearly explains what was changed and why: restoring examples to two documentation pages that were moved or lost, keeping the how-to focused on profile-based commands while moving option-based commands to the reference page.
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-bundle-docs

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: 1

🤖 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 `@docs/cli/changelog/cmd-bundle.md`:
- Around line 172-174: The markdown contains an empty link label
"[](/cli/changelog/gh-release.md)" which renders as a blank anchor; update that
link in the changelog text to include a visible label such as "[gh-release]" or
"[docs-builder changelog gh-release]" so the reference becomes
"[gh-release](/cli/changelog/gh-release.md)" (locate the line containing the
empty brackets in the cmd-bundle.md paragraph and replace the empty label with
an appropriate, descriptive link text).
🪄 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: 08ee829a-ac47-4c98-9111-d590af0dd382

📥 Commits

Reviewing files that changed from the base of the PR and between 908493a and 3575023.

📒 Files selected for processing (2)
  • docs/cli/changelog/cmd-bundle.md
  • docs/contribute/bundle-changelogs.md

Comment thread docs/cli/changelog/cmd-bundle.md
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.

1 participant