MAI-14: document CI auto-version-bump workflow#10
Merged
Conversation
Added narrative documentation for the --create-gh-action, --show-gl-excerpt, and --show-bb-excerpt flags. They are in --help but were undocumented elsewhere; users discovering them had no path to the PAT/token/app-password setup steps per provider. - docs/workflow.md: new "CI Auto-Version-Bump on PR Merge" section covering the value prop, the three install commands, per-provider auth setup, the MAIASS_DEVELOPBRANCH bake-in (MAI-13), the double- bump guard mechanism, and the AI-disabled-in-CI note. - docs/commands.md: new "CI Setup Commands" subsection under Command Structure, listing all three flags with one-liners and a link to the workflow.md walkthrough. - docs/setup.md: short "Continuous Integration" section before Troubleshooting, with a link to workflow.md. - docs/configuration.md: callout under "Branch Configuration" cross-referencing the CI template substitution. - README.md: new "CI auto-version-bump" bullet under Key Features. https://velvary.atlassian.net/browse/MAI-14
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.
Summary
The CI auto-version-bump flags (`--create-gh-action`, `--show-gl-excerpt`, `--show-bb-excerpt`) appeared in `maiass --help` but were undocumented in `docs/` and the README. Adds narrative coverage so users have a real install path.
Test plan
Ticket: https://velvary.atlassian.net/browse/MAI-14
Related: MAI-13 (substitution feature shipped)