Move CLI docs generator to scheduled action#158
Conversation
Preview Deployment
Commit: |
Lighthouse Results
|
E2E Test Results✅ Tests success Ran against: https://pr-158-superfly-sprites-docs.fly.dev |
Currently, generating CLI docs is part of the main CI action. Whenever someone opens a pull request, the bot fetches the latest CLI, generates new docs, and inserts a commit into the PR. The extra commit makes PRs noisier to review and can cause merge conflicts. Instead, run the generator on a weekly schedule. The action has its own branch: `actions/update-cli-docs`. Every monday, the action will checkout main, run the CLI tests, update the docs with the week's CLI changes, and force push to the branch. Finally, the bot either opens a new PR, or updates the previous week's if it hasn't been merged yet.
jbellerb
force-pushed
the
jae/push-rlxuxlmxqrzt
branch
from
33083bb to
5d50ca0
Compare
kcmartin
left a comment
kcmartin
left a comment
There was a problem hiding this comment.
left one comment. Otherwise it looks good!
| - name: Generate CLI Docs | ||
| run: pnpm generate:cli-docs | ||
| env: | ||
| SKIP_CLI_TESTS: 'true' |
There was a problem hiding this comment.
Noticed SKIP_CLI_TESTS was dropped. The old CI step set it to true, but the new workflow doesn't. Was that intentional? Want to make sure the tests can pass in the Actions environment without a live Sprite.
There was a problem hiding this comment.
Yes. I wasn't here when it was changed, but I had assumed the skip was there to avoid blocking PRs while CLI fixes are still being worked on. Since this workflow is async, it's fine to block and the tests can be re-enabled.
kcmartin
left a comment
kcmartin
left a comment
There was a problem hiding this comment.
Thanks for answering that question. LGTM!
2 participants
Currently, generating CLI docs is part of the main CI action. Whenever
someone opens a pull request, the bot fetches the latest CLI, generates
new docs, and inserts a commit into the PR. The extra commit makes
PRs noisier to review and can cause merge conflicts. Instead, run the
generator on a weekly schedule.
The action has its own branch:
actions/update-cli-docs. Every monday,the action will checkout main, run the CLI tests, update the docs with
the week's CLI changes, and force push to the branch. Finally, the bot
either opens a new PR, or updates the previous week's if it hasn't been
merged yet.