Skip to content

Commit 5aedcd6

Browse files
committed
docs: add example workflows and adoption strategy
1 parent 9fa6c9c commit 5aedcd6

5 files changed

Lines changed: 492 additions & 0 deletions

File tree

ADOPTION_STRATEGY.md

Lines changed: 259 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,259 @@
1+
# Adoption Strategy for setup-goose-action
2+
3+
Comprehensive plan to drive awareness and adoption.
4+
5+
## Phase 1: Community Awareness (Week 1)
6+
7+
### Goose Community
8+
- [ ] Post announcement in Goose Discord (#announcements, #showcase)
9+
- [ ] Share in Goose discussions: https://github.com/block/goose/discussions
10+
- [ ] Comment on relevant Goose issues/PRs mentioning CI/CD use cases
11+
12+
### Social Media
13+
- [ ] Twitter/X thread with examples and use cases
14+
- [ ] LinkedIn post targeting DevOps/SRE audience
15+
- [ ] Bluesky announcement (Block is active there)
16+
- [ ] Dev.to article: "Automating Code Review with Goose and GitHub Actions"
17+
- [ ] Hashnode/Medium cross-post
18+
19+
### GitHub
20+
- [ ] Add to Awesome Goose lists (if they exist)
21+
- [ ] Submit to Awesome GitHub Actions: https://github.com/sdras/awesome-actions
22+
- [ ] Post in GitHub Actions community discussions
23+
24+
---
25+
26+
## Phase 2: Content Marketing (Week 2-3)
27+
28+
### Blog Posts / Articles
29+
1. **"How to Add AI Code Review to Your CI/CD Pipeline"**
30+
- Problem: Manual code review bottlenecks
31+
- Solution: Automated AI review with Goose
32+
- Tutorial: Step-by-step setup
33+
- Results: Time savings, quality improvements
34+
35+
2. **"3 Ways Goose GitHub Action Improves Your Workflow"**
36+
- PR review automation
37+
- Test generation
38+
- Documentation sync
39+
40+
3. **"From Manual to Automated: Our Journey with AI in CI/CD"**
41+
- Personal story/case study
42+
- Before/after metrics
43+
- Lessons learned
44+
45+
### Video Content
46+
- [ ] YouTube tutorial: "Setup Goose Action in 5 Minutes"
47+
- [ ] Loom demo: Quick walkthrough
48+
- [ ] Add to video to README
49+
50+
### Documentation
51+
- [x] Example workflows (created)
52+
- [ ] Best practices guide
53+
- [ ] Troubleshooting FAQ
54+
- [ ] Cost optimization tips
55+
56+
---
57+
58+
## Phase 3: Community Engagement (Ongoing)
59+
60+
### Support & Feedback
61+
- [ ] Monitor GitHub issues daily
62+
- [ ] Respond to questions in Goose Discord
63+
- [ ] Track mentions on Twitter/social
64+
- [ ] Collect feature requests
65+
66+
### Collaboration
67+
- [ ] Reach out to Goose maintainers for feedback
68+
- [ ] Ask Block to mention in Goose docs/blog
69+
- [ ] Collaborate with other action authors
70+
- [ ] Contribute examples to block/goose repo
71+
72+
### Showcases
73+
- [ ] Feature user success stories in README
74+
- [ ] Create "Built with setup-goose-action" showcase
75+
- [ ] Highlight innovative use cases
76+
77+
---
78+
79+
## Phase 4: Strategic Partnerships (Month 2+)
80+
81+
### Integration Opportunities
82+
- [ ] Partner with CI/CD platforms (CircleCI, GitLab CI)
83+
- [ ] Integrate with code quality tools (SonarQube, CodeClimate)
84+
- [ ] Create starter templates for popular frameworks
85+
86+
### Conference/Meetup Talks
87+
- [ ] Submit to GitHub Universe
88+
- [ ] Present at local DevOps meetups
89+
- [ ] Guest on AI/DevOps podcasts
90+
91+
### Open Source Projects
92+
- [ ] Add GitHub Action to popular repos (with permission)
93+
- [ ] Create PRs adding setup-goose-action to real projects
94+
- [ ] Sponsor/contribute to related projects
95+
96+
---
97+
98+
## Metrics to Track
99+
100+
### Usage Metrics
101+
- GitHub Action runs per day/week
102+
- Unique repositories using the action
103+
- Stars/forks on repo
104+
- Marketplace views/installations
105+
106+
### Engagement Metrics
107+
- GitHub issues opened
108+
- PR contributions
109+
- Discord mentions
110+
- Social media engagement (likes, shares, comments)
111+
112+
### Quality Metrics
113+
- Issue resolution time
114+
- User satisfaction (via feedback)
115+
- Success rate (% of successful runs)
116+
- Cache hit rate
117+
118+
---
119+
120+
## Quick Wins (Do This Week)
121+
122+
### High Impact, Low Effort
123+
1. [x] Publish to marketplace (DONE)
124+
2. [ ] Post to Goose Discord
125+
3. [ ] Tweet announcement
126+
4. [ ] Add examples/ directory to repo
127+
5. [ ] Update README with "Example Use Cases" section
128+
6. [ ] Submit to awesome-actions list
129+
7. [ ] Create demo video (5 min)
130+
8. [ ] Write Dev.to article
131+
132+
### Medium Impact, Medium Effort
133+
1. [ ] Comprehensive blog post
134+
2. [ ] Reach out to Block team
135+
3. [ ] Create video tutorial
136+
4. [ ] Add to Goose official docs (PR)
137+
138+
---
139+
140+
## Long-term Vision
141+
142+
### Features to Build
143+
- [ ] Support for Windows runners
144+
- [ ] Pre-configured profiles (code-review, test-gen, docs)
145+
- [ ] Output formatters (markdown, JSON, GitHub comments)
146+
- [ ] Multi-file diff analysis
147+
- [ ] Integration with GitHub Code Scanning
148+
149+
### Community Growth
150+
- [ ] Contributor guide
151+
- [ ] Good first issues
152+
- [ ] Monthly releases with improvements
153+
- [ ] User testimonials
154+
155+
---
156+
157+
## Templates for Outreach
158+
159+
### Discord Announcement
160+
```
161+
🚀 Exciting news for Goose users!
162+
163+
I just published setup-goose-action to GitHub Marketplace!
164+
165+
Now you can integrate Goose into your CI/CD pipelines:
166+
167+
```yaml
168+
- uses: clouatre-labs/setup-goose-action@v1
169+
```
170+
171+
Perfect for:
172+
✅ Automated PR reviews
173+
✅ Test generation
174+
✅ Documentation updates
175+
✅ Code quality checks
176+
177+
Check it out: https://github.com/marketplace/actions/setup-goose-cli
178+
179+
Examples: https://github.com/clouatre-labs/setup-goose-action/tree/main/examples
180+
181+
Would love your feedback!
182+
```
183+
184+
### Twitter Thread
185+
```
186+
🤖 Thread: How to add AI-powered code review to your GitHub Actions
187+
188+
I just published setup-goose-action - it brings @block's Goose AI agent to your CI/CD pipeline
189+
190+
Here's what you can automate 🧵
191+
192+
1/ First, what is Goose?
193+
Goose is an open-source AI agent that can write code, run tests, and analyze your codebase.
194+
195+
It's like having a senior developer reviewing every PR.
196+
197+
2/ The problem:
198+
Manual code review is slow. PRs sit for days waiting for review.
199+
200+
Solution: Automated AI review catches obvious issues before human review.
201+
202+
3/ Setup is dead simple:
203+
204+
```yaml
205+
- uses: clouatre-labs/setup-goose-action@v1
206+
```
207+
208+
That's it. Goose is now in your workflow.
209+
210+
4/ Real example - automated PR review:
211+
[attach screenshot of example workflow]
212+
213+
Goose reviews changed files and comments on issues it finds.
214+
215+
5/ What else can you automate?
216+
- Generate unit tests
217+
- Update documentation
218+
- Refactor code
219+
- Security scans
220+
- Migration helpers
221+
222+
6/ Try it yourself:
223+
Marketplace: https://github.com/marketplace/actions/setup-goose-cli
224+
Examples: [link]
225+
226+
What would YOU automate with AI in CI/CD? Reply below 👇
227+
```
228+
229+
---
230+
231+
## Budget Considerations
232+
233+
### Free/Low Cost
234+
- Social media posting
235+
- GitHub discussions
236+
- Discord engagement
237+
- Blog posts (own blog or Dev.to)
238+
- Video tutorials (YouTube)
239+
240+
### Paid Options (Optional)
241+
- Sponsored tweets/posts
242+
- Conference tickets
243+
- Paid ads on Dev.to
244+
- Newsletter sponsorships
245+
246+
---
247+
248+
## Success Criteria (3 Months)
249+
250+
- [ ] 100+ stars on GitHub
251+
- [ ] 50+ repositories using the action
252+
- [ ] 10+ community contributions (issues/PRs)
253+
- [ ] Featured in Goose documentation
254+
- [ ] 1,000+ GitHub Action runs
255+
- [ ] 5+ testimonials/case studies
256+
257+
---
258+
259+
**Remember:** Focus on providing value. Share real examples, help users succeed, and build a community around the action.

examples/README.md

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
# Example Workflows
2+
3+
Real-world examples of using setup-goose-action in GitHub Actions.
4+
5+
## Quick Start
6+
7+
All examples require a Goose-compatible API key as a GitHub secret:
8+
- Google Gemini: `GEMINI_API_KEY`
9+
- OpenAI: `OPENAI_API_KEY`
10+
- Anthropic: `ANTHROPIC_API_KEY`
11+
12+
Add your API key to repository secrets: `Settings > Secrets and variables > Actions > New repository secret`
13+
14+
---
15+
16+
## Examples
17+
18+
### 1. [AI Code Review](pr-review.yml)
19+
Automatically review pull requests for logic issues, bugs, and improvements.
20+
21+
**Use case:** Catch issues before human review, improve code quality
22+
23+
**Triggers:** On PR open/update
24+
25+
**Requirements:** Read access to code, write access to PRs
26+
27+
---
28+
29+
### 2. [Test Generation](test-generation.yml)
30+
Generate unit tests for new code automatically.
31+
32+
**Use case:** Maintain test coverage, reduce manual test writing
33+
34+
**Triggers:** On PR with new source code
35+
36+
**Requirements:** Write access to create PRs
37+
38+
---
39+
40+
### 3. [Documentation Updates](documentation.yml)
41+
Keep documentation in sync with code changes.
42+
43+
**Use case:** Prevent stale docs, automated API documentation
44+
45+
**Triggers:** On push to main
46+
47+
**Requirements:** Write access to commit docs
48+
49+
---
50+
51+
## Configuration Tips
52+
53+
### Performance Optimization
54+
```yaml
55+
- uses: clouatre-labs/setup-goose-action@v1
56+
with:
57+
version: '1.14.0' # Pin version for reproducibility
58+
```
59+
60+
### Multi-Model Strategy
61+
```yaml
62+
env:
63+
# Use fast model for simple tasks
64+
GOOSE_MODEL: gemini-2.0-flash-exp
65+
GOOGLE_API_KEY: ${{ secrets.GEMINI_API_KEY }}
66+
```
67+
68+
### Cost Control
69+
```yaml
70+
# Run only on specific paths
71+
on:
72+
pull_request:
73+
paths:
74+
- 'src/**'
75+
- '!src/test/**' # Exclude test files
76+
```
77+
78+
---
79+
80+
## Custom Workflows
81+
82+
Copy and adapt these examples for your needs:
83+
- Code migration (framework upgrades)
84+
- Security scanning (vulnerability detection)
85+
- Refactoring suggestions
86+
- Changelog generation
87+
- Release notes writing
88+
89+
---
90+
91+
## Support
92+
93+
- Report issues: https://github.com/clouatre-labs/setup-goose-action/issues
94+
- Goose docs: https://block.github.io/goose/
95+
- Goose Discord: https://discord.gg/goose-oss

0 commit comments

Comments
 (0)