@activade/open-workflows 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +95 -0
- package/dist/cli/index.d.ts +2 -0
- package/dist/cli/index.js +651 -0
- package/dist/cli/installer.d.ts +24 -0
- package/dist/cli/templates/auth.d.ts +1 -0
- package/dist/cli/templates/doc-sync.d.ts +1 -0
- package/dist/cli/templates/index.d.ts +7 -0
- package/dist/cli/templates/issue-label.d.ts +1 -0
- package/dist/cli/templates/pr-review.d.ts +1 -0
- package/dist/cli/templates/release.d.ts +1 -0
- package/dist/cli/templates/shared.d.ts +3 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.js +62 -0
- package/dist/skills/doc-sync.d.ts +1 -0
- package/dist/skills/index.d.ts +10 -0
- package/dist/skills/issue-label.d.ts +1 -0
- package/dist/skills/pr-review.d.ts +1 -0
- package/dist/skills/release-notes.d.ts +1 -0
- package/dist/tools/apply-labels/index.d.ts +2 -0
- package/dist/tools/apply-labels/schema.d.ts +12 -0
- package/dist/tools/bun-release/index.d.ts +2 -0
- package/dist/tools/bun-release/schema.d.ts +4 -0
- package/dist/tools/github-release/index.d.ts +2 -0
- package/dist/tools/github-release/schema.d.ts +9 -0
- package/dist/tools/index.d.ts +2 -0
- package/dist/tools/submit-review/index.d.ts +2 -0
- package/dist/tools/submit-review/schema.d.ts +24 -0
- package/dist/tools/utils/retry.d.ts +7 -0
- package/package.json +61 -0
package/README.md
ADDED
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
# open-workflows
|
|
2
|
+
|
|
3
|
+
AI-powered GitHub automation workflows as an OpenCode plugin. Uses **Skills** for customizable PR reviews, issue labeling, documentation sync, and release automation.
|
|
4
|
+
|
|
5
|
+
Powered by [OpenCode](https://opencode.ai).
|
|
6
|
+
|
|
7
|
+
## Quick Start
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
bunx open-workflows
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
The CLI will:
|
|
14
|
+
1. Prompt you to select workflows
|
|
15
|
+
2. Install skills to `.opencode/skill/`
|
|
16
|
+
3. Install GitHub Actions workflows to `.github/workflows/`
|
|
17
|
+
4. Create/update `.opencode/opencode.json`
|
|
18
|
+
|
|
19
|
+
## What's Installed
|
|
20
|
+
|
|
21
|
+
### Skills (`.opencode/skill/`)
|
|
22
|
+
|
|
23
|
+
| Skill | Description |
|
|
24
|
+
|-------|-------------|
|
|
25
|
+
| `pr-review` | AI-powered code review with structured findings |
|
|
26
|
+
| `issue-label` | Auto-label issues based on content |
|
|
27
|
+
| `doc-sync` | Keep docs in sync with code changes |
|
|
28
|
+
| `release-notes` | Semantic versioning and release automation |
|
|
29
|
+
|
|
30
|
+
### Workflows (`.github/workflows/`)
|
|
31
|
+
|
|
32
|
+
| Workflow | Trigger | Description |
|
|
33
|
+
|----------|---------|-------------|
|
|
34
|
+
| `pr-review.yml` | Pull request | Reviews PRs using `pr-review` skill |
|
|
35
|
+
| `issue-label.yml` | Issue opened/edited | Labels issues using `issue-label` skill |
|
|
36
|
+
| `doc-sync.yml` | Pull request | Syncs docs using `doc-sync` skill |
|
|
37
|
+
| `release.yml` | Manual dispatch | Creates releases using `release-notes` skill |
|
|
38
|
+
|
|
39
|
+
## CLI Options
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
bunx open-workflows [OPTIONS]
|
|
43
|
+
|
|
44
|
+
OPTIONS
|
|
45
|
+
--skills Install skills only
|
|
46
|
+
--workflows Install workflows only
|
|
47
|
+
--version, -v Display version
|
|
48
|
+
--help, -h Display help
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
## Plugin Installation
|
|
52
|
+
|
|
53
|
+
Add to your `opencode.json`:
|
|
54
|
+
|
|
55
|
+
```json
|
|
56
|
+
{
|
|
57
|
+
"plugin": ["@activade/open-workflows"]
|
|
58
|
+
}
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
The plugin provides 4 tools for the skills to use:
|
|
62
|
+
- `submit_review` - Post PR review comments
|
|
63
|
+
- `apply_labels` - Apply labels to issues
|
|
64
|
+
- `github_release` - Create GitHub releases
|
|
65
|
+
- `bun_release` - Publish to npm
|
|
66
|
+
|
|
67
|
+
## GitHub Secrets
|
|
68
|
+
|
|
69
|
+
Add your API key as a GitHub Actions secret:
|
|
70
|
+
|
|
71
|
+
```bash
|
|
72
|
+
gh secret set ANTHROPIC_API_KEY
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
For the release workflow, also add:
|
|
76
|
+
|
|
77
|
+
```bash
|
|
78
|
+
gh secret set NPM_TOKEN
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
## How It Works
|
|
82
|
+
|
|
83
|
+
1. GitHub Actions trigger on events (PR, issue, manual)
|
|
84
|
+
2. Workflow runs OpenCode with a task message
|
|
85
|
+
3. OpenCode loads the appropriate skill
|
|
86
|
+
4. Skill guides the AI through the workflow
|
|
87
|
+
5. AI uses the plugin's tools to complete actions
|
|
88
|
+
|
|
89
|
+
## Customizing Skills
|
|
90
|
+
|
|
91
|
+
Skills are just markdown files. After installation, edit `.opencode/skill/*/SKILL.md` to customize behavior.
|
|
92
|
+
|
|
93
|
+
## License
|
|
94
|
+
|
|
95
|
+
MIT
|