Skip to content

Improve examples and fix badge order#10

Merged
clouatre merged 1 commit intomainfrom
docs/improve-examples
Nov 14, 2025
Merged

Improve examples and fix badge order#10
clouatre merged 1 commit intomainfrom
docs/improve-examples

Conversation

@clouatre
Copy link
Copy Markdown
Member

Improvements

Based on learnings from setup-q-cli-action development:

1. Badge Order ✅

Before: Marketplace → Test → License → Release
After: Test → Marketplace → License → Release
(Follows GitHub Actions best practice - CI status first)

2. New Examples Section ✅

Added practical, validated examples:

  • Security scan with artifact upload - Scan files and save results
  • Version pinning - Pin to specific Goose version

3. Permissions Documentation ✅

Quick Start now shows required permissions:

  • pull-requests: write for PR comments
  • contents: read for artifact uploads

4. All Examples Validated ✅

Tested with Goose CLI v1.13.1:

  • --instructions - (stdin) ✅
  • --instructions file.txt
  • --no-session --quiet

Changes

  • +47 lines (concise, actionable)
  • No breaking changes
  • Existing syntax already correct

Related

  • Inspired by setup-q-cli-action marketplace publication

- Fix badge order: Test → Marketplace → License → Release
- Add Examples section with security scan + artifact upload
- Add version pinning example
- Document permissions needed (pull-requests: write, contents: read)
- All examples validated with Goose CLI v1.13.1

Net: +47 lines (concise, actionable examples)
@clouatre clouatre merged commit bd70666 into main Nov 14, 2025
4 checks passed
@clouatre clouatre deleted the docs/improve-examples branch November 14, 2025 23:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant