Skip to content

feat: Add GitHub Marketplace badge and production-ready examples for v1.0.3#7

Merged
clouatre merged 2 commits intomainfrom
feat/update-readme-v1.0.3-marketplace
Nov 13, 2025
Merged

feat: Add GitHub Marketplace badge and production-ready examples for v1.0.3#7
clouatre merged 2 commits intomainfrom
feat/update-readme-v1.0.3-marketplace

Conversation

@clouatre
Copy link
Copy Markdown
Member

Overview

Updates README for GitHub Marketplace release (v1.0.3) with tested, production-ready examples.

Changes

Added

  • GitHub Marketplace badge and link
  • Prerequisites section explaining API key setup
  • Quick Start example: Simple AI code review workflow
  • Advanced example: PR comment posting workflow

Fixed

  • CRITICAL: Removed non-existent --diff-file flag (doesn't exist in Goose v1.14.0)
  • Use correct --instructions flag for passing files to goose run
  • YAML config now uses heredoc for proper multi-line formatting (not \n strings)
  • File-based output approach (more reliable than heredoc in $GITHUB_OUTPUT)
  • Added --no-session and --quiet flags for cleaner CI output
  • Error handling for empty diffs

Testing

All examples tested in Docker with Goose v1.14.0:

✅ YAML heredoc configuration works
✅ All command flags validated (--instructions, --no-session, --quiet)
✅ Instruction file approach confirmed working
✅ File-based output method validated
✅ Empty diff detection logic tested
✅ Command reaches Google API (tested with fake key - got expected 400)

See test artifacts in test-docker/ directory (not included in PR).

Breaking Changes

None - only documentation updates.

Related Issues

Preparation for v1.0.3 GitHub Marketplace release.

Checklist

  • Examples tested in Docker environment
  • All command flags verified against Goose v1.14.0
  • YAML syntax validated
  • GitHub Actions best practices followed
  • No emojis in documentation
  • Commit message follows conventional commits

Test added 2 commits November 13, 2025 13:45
- Add GitHub Marketplace badge and link
- Add Prerequisites section for API key setup
- Add Quick Start example with corrected goose run usage
- Add Advanced example for posting PR comments
- Use --instructions flag (not --diff-file which doesn't exist)
- Use heredoc for YAML config (proper newlines)
- Add error handling for empty diffs
- Use file-based output for reliability
- Tested in Docker with Goose v1.14.0
@clouatre clouatre merged commit 16b34fa into main Nov 13, 2025
4 checks passed
@clouatre clouatre deleted the feat/update-readme-v1.0.3-marketplace branch November 13, 2025 19:02
clouatre added a commit that referenced this pull request Nov 13, 2025
…v1.0.3 (#7)

* feat: add GitHub Marketplace badge and production-ready examples

- Add GitHub Marketplace badge and link
- Add Prerequisites section for API key setup
- Add Quick Start example with corrected goose run usage
- Add Advanced example for posting PR comments
- Use --instructions flag (not --diff-file which doesn't exist)
- Use heredoc for YAML config (proper newlines)
- Add error handling for empty diffs
- Use file-based output for reliability
- Tested in Docker with Goose v1.14.0

* docs: simplify Prerequisites section and link to official providers docs
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