docs: restructure README#6
Open
sundram-bruno wants to merge 2 commits into
Open
Conversation
Refresh the README for the demo and current published state. Structure: - Reordered sections: Usage → Customize (Inputs/Outputs/Behavior) → Versioning → Examples → Troubleshooting → Resources → License. - Top-level TOC matches the new order so readers can land on any section directly. - Dropped the introductory line that compared this action's design to other vendors' actions; the structure itself now communicates the pattern. Inputs section: - Added a worked example that uses all three inputs (command, bru-version, working-directory) so users see a realistic invocation alongside the table. Version pins: - Every `uses: usebruno/bruno-cli-action@v1` updated to `@v0`, matching the floating major tag actually published to the Marketplace. - Versioning table now shows `@v0` / `@v0.0.0` rather than the pre-publish `@v1` / `@v1.2.3` placeholders. Supersedes usebruno#4 and usebruno#5.
Tighten the README ahead of the v1 announcement. Structure: - Trimmed Examples down to the six most-asked recipes: PR sticky comment, dorny Checks tab, artifact upload with sanitization, multi-format reports, Slack on failure, gh CLI PR comment. - Removed the Behavior subsection and the Troubleshooting block (including the long exit-code reference) since users hitting issues land on the Bruno CLI docs first anyway. - Promoted "Other CI platforms" out of Examples into its own top-level section. - Updated the TOC to match. Inputs table: - Reshaped to a 3-column layout (Name | Type | Description) to match the pattern that mature first-party CLI actions use. Required/Default metadata moves into the Description column (Required. ... / (Default: X)). Version pins: - Every `usebruno/bruno-cli-action@v0` updated to `@v1`, matching the public release tag that ships with the announcement. - Versioning table updated to `@v1` / `@v1.0.0`.
sid-bruno
approved these changes
Jun 10, 2026
sundram-bruno
changed the title
sundram-bruno
changed the title
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
2 participants
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.
Refresh the README for the demo and current published state.
Structure
Inputs section
Version pins