Skip to content

[DOCS] Add profile example for --all bundle, fix path for changelog syntax docs#2980

Merged
lcawl merged 6 commits intomainfrom
changelog-profile-docs
Apr 2, 2026
Merged

[DOCS] Add profile example for --all bundle, fix path for changelog syntax docs#2980
lcawl merged 6 commits intomainfrom
changelog-profile-docs

Conversation

@lcawl
Copy link
Copy Markdown
Contributor

@lcawl lcawl commented Mar 28, 2026

Relates to #2973

This PR adds an example of how to accomplish the changelog bundle --all filtering option via a profile. For now this involves passing an unused version argument, but in the long-term the issue describes a better solution for this.

This PR also moves all the changelog syntax pages from the release folder to a changelog folder, since the former was often accidentally omitted from the build due to CI that ignored release updates (e.g. the errors in #3002)

NOTE: This PR must be merged after #3008, which addresses the redirect test failures.

@lcawl lcawl added the documentation Improvements or additions to documentation label Mar 28, 2026
@lcawl lcawl requested review from a team as code owners March 28, 2026 01:07
@lcawl lcawl requested a review from Mpdreamz March 28, 2026 01:07
@lcawl lcawl force-pushed the changelog-profile-docs branch from b76116b to 6717af2 Compare March 28, 2026 01:09
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Mar 28, 2026

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

This PR reorganizes CLI changelog documentation: files were moved from docs/cli/release/ to docs/cli/changelog/ and the changelog- filename prefix was removed. The docs/_docset.yml TOC was updated (folder: releasefolder: changelog and child filenames adjusted), docs/_redirects.yml adds redirects from old /cli/release/ routes to /cli/changelog/, internal links across docs were updated, and docs/cli/release/index.md was removed and replaced by docs/cli/changelog/index.md. No code or public API changes were made.

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main changes: adding a profile example for changelog bundle --all and reorganizing docs from release to changelog folder.
Description check ✅ Passed The description is directly related to the changeset, explaining both the profile example addition and the folder reorganization with clear context about CI issues.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ 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-profile-docs

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

@lcawl lcawl changed the title [DOCS] Add profile example for --all bundle [DOCS] Add profile example for --all bundle, fix path for changelog syntax docs Mar 31, 2026
This was referenced Mar 31, 2026
Copy link
Copy Markdown
Member

@Mpdreamz Mpdreamz left a comment

Choose a reason for hiding this comment

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

LGTM! Nice cleanup.

For context: this PR documents how to use a profile for the equivalent of changelog bundle --all (passing an unused version arg as a workaround until requires_version: false lands per #2973), and moves the changelog docs from cli/release/ to cli/changelog/ — the old path was being silently skipped by CI filters that ignored release/ updates. The folder rename adds redirects in _redirects.yml, which depend on #3008 to fix the authoring test harness first.

@lcawl lcawl force-pushed the changelog-profile-docs branch from e6c6625 to b65d08d Compare April 2, 2026 15:35
@lcawl lcawl enabled auto-merge (squash) April 2, 2026 15:36
@lcawl lcawl merged commit f3e53bb into main Apr 2, 2026
28 checks passed
@lcawl lcawl deleted the changelog-profile-docs branch April 2, 2026 16:46
cotti pushed a commit that referenced this pull request Apr 7, 2026
itsalexcm pushed a commit that referenced this pull request Apr 7, 2026
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