Fix changelog bundle examples#3359
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughThis 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)
✏️ 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: 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
📒 Files selected for processing (2)
docs/cli/changelog/cmd-bundle.mddocs/contribute/bundle-changelogs.md
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.