Skip to content

build: regenerate reference docs from nothing for each release - #484

Merged
zimeg merged 1 commit into
mainfrom
zimeg-chore-docs-regenerate
Apr 10, 2026
Merged

zimeg merged 1 commit into
mainfrom
zimeg-chore-docs-regenerate

Conversation

@zimeg

@zimeg zimeg commented Apr 10, 2026

Copy link
Copy Markdown
Member

Changelog

N/A. But we hope to continue with current reference 🤓

Summary

This PR regenerates reference docs from nothing for each release to avoid issues where "stale" files from removed commands might remain in reference.

Reviewers

Please confirm no diff is created when running the following commands:

rm -rf ./docs/reference/commands ./docs/reference/errors.md
./bin/slack docgen ./docs/reference --skip-update

Requirements

@zimeg zimeg added this to the Next Release milestone Apr 10, 2026
@zimeg zimeg self-assigned this Apr 10, 2026
@zimeg
zimeg requested a review from a team as a code owner April 10, 2026 21:19
@zimeg zimeg added docs M-T: Documentation work only semver:patch Use on pull requests to describe the release version increment build M-T: Changes to compilation and CI processes labels Apr 10, 2026

@lukegalbraithrussell lukegalbraithrussell left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

wonderful

@zimeg

zimeg commented Apr 10, 2026

Copy link
Copy Markdown
Member Author

@lukegalbraithrussell The -rf does mean really fast! Thanks for the review!

Another approach considered might've adjusted the docgen command to do similar but that might be more destructive than needed and perhaps not ideal for certain setups 👾

@codecov

codecov Bot commented Apr 10, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 71.23%. Comparing base (45cb893) to head (cff9628).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #484      +/-   ##
==========================================
+ Coverage   71.22%   71.23%   +0.01%     
==========================================
  Files         222      222              
  Lines       18664    18664              
==========================================
+ Hits        13293    13296       +3     
+ Misses       4191     4189       -2     
+ Partials     1180     1179       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@zimeg
zimeg enabled auto-merge (squash) April 10, 2026 21:23
@zimeg
zimeg merged commit 346be01 into main Apr 10, 2026
8 checks passed
@zimeg
zimeg deleted the zimeg-chore-docs-regenerate branch April 10, 2026 21:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

build M-T: Changes to compilation and CI processes docs M-T: Documentation work only semver:patch Use on pull requests to describe the release version increment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants