Open
Conversation
Contributor
Preview Deployment
Commit: |
Contributor
Lighthouse Results
|
Contributor
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.