groove-groovebook-publish
Use $ARGUMENTS as the learning text if provided.
Outcome
A learning from the current project is published to the configured groovebook repo as a pull request, stripped of any project-specific context, ready for community review.
Acceptance Criteria
- Learning is published as a PR to
<groovebook> repo
- PR uses the groovebook PR template format (Summary, Context, Learning, Groove skill area)
- File is written at
learned/<topic>/<YYYY-MM-DD>-<slug>.md in the groovebook repo
- PR URL is printed to the user
Steps
Read groovebook: from .groove/index.md; if absent, exit with:
groovebook is not configured. Add 'groovebook: <owner>/<repo>' to .groove/index.md to enable.
Check gh auth status; if not authenticated, exit with:
Not authenticated with GitHub. Run: gh auth login
Verify the groovebook repo is accessible: gh repo view <groovebook>; if it fails, exit with a clear message.
Get the learning text:
- If $ARGUMENTS is provided, use it as a starting point
- Otherwise: ask "What's the learning you'd like to publish? (paste it or describe briefly)"
- Ask for a one-sentence summary (used as PR title and filename slug)
Show a preview of the learning text and ask:
Does this contain any repo-specific context to redact? (file paths, internal names, product names)
- If yes: help the user redact it — replace specific names with generic descriptions
- If no: proceed
Ask for topic (e.g. patterns, tools, anti-patterns, workflow) and skill area (e.g. compound, plan, review, daily)
Generate slug: lowercase the summary, replace spaces with hyphens, strip special characters, truncate to 40 chars. Construct:
- Branch name:
learning/<YYYY-MM-DD>-<slug>
- File path:
learned/<topic>/<YYYY-MM-DD>-<slug>.md
Fork the groovebook repo if not already forked: gh repo fork <groovebook> --clone=false
- If fork already exists, skip silently
Create the branch and file:
gh api repos/<user-fork>/git/refs to check if branch exists; if so, append a short unique suffix
- Write the file content (see format below) and commit via
gh api
- Or: use
git operations against the fork URL if gh api approach is too complex — prefer the simpler path
Open the PR:
gh pr create --repo <groovebook> \
--title "<one-sentence summary>" \
--body "<formatted body>" \
--head "<fork-user>:<branch-name>"
Print the PR URL
Learning file format
---
date: YYYY-MM-DD
topic: <topic>
skill-area: <skill-area>
source: groovebook-publish
---
# <One-sentence summary>
## Context
<What triggered this learning — what problem were you solving? Generic, no project specifics.>
## Learning
<The insight itself — what to do, what to avoid, or what pattern works.>
## Groove skill area
`<skill-area>` (e.g. `groove-work-compound`, `groove-work-plan`)
PR body format
## Summary
<one-sentence summary>
## Context
<what triggered this>
## Learning
<the insight>
## Groove skill area
`<skill-area>`
---
*Published via groove-groovebook-publish*
Constraints
- Never publish learning text that contains project-specific names, file paths, or internal identifiers without explicit user confirmation that it's intentional
- If the fork step fails due to permissions: suggest the user fork manually and set their fork as the
groovebook: value
- Slug must be safe for use as a filename: lowercase, hyphens only, no path separators or special characters
- If branch already exists: append
-2, -3, etc. until a free name is found
1---2name: groove-groovebook-publish3description: Publish a workflow learning to the groovebook shared commons as a GitHub PR. Use after groove-work-compound when a learning is worth sharing.4license: MIT5---6
7# groove-groovebook-publish
8
9Use $ARGUMENTS as the learning text if provided.
10
11## Outcome
12
13A learning from the current project is published to the configured groovebook repo as a pull request, stripped of any project-specific context, ready for community review.
14
15## Acceptance Criteria
16
17- Learning is published as a PR to `<groovebook>` repo
18- PR uses the groovebook PR template format (Summary, Context, Learning, Groove skill area)
19- File is written at `learned/<topic>/<YYYY-MM-DD>-<slug>.md` in the groovebook repo
20- PR URL is printed to the user
21
22## Steps
23
241. Read `groovebook:` from `.groove/index.md`; if absent, exit with:
25 `groovebook is not configured. Add 'groovebook: <owner>/<repo>' to .groove/index.md to enable.`
26
272. Check `gh auth status`; if not authenticated, exit with:
28 `Not authenticated with GitHub. Run: gh auth login`
29
303. Verify the groovebook repo is accessible: `gh repo view <groovebook>`; if it fails, exit with a clear message.
31
324. Get the learning text:
33 - If $ARGUMENTS is provided, use it as a starting point
34 - Otherwise: ask "What's the learning you'd like to publish? (paste it or describe briefly)"
35 - Ask for a one-sentence summary (used as PR title and filename slug)
36
375. Show a preview of the learning text and ask:
38 `Does this contain any repo-specific context to redact? (file paths, internal names, product names)`
39 - If yes: help the user redact it — replace specific names with generic descriptions
40 - If no: proceed
41
426. Ask for topic (e.g. `patterns`, `tools`, `anti-patterns`, `workflow`) and skill area (e.g. `compound`, `plan`, `review`, `daily`)
43
447. Generate slug: lowercase the summary, replace spaces with hyphens, strip special characters, truncate to 40 chars. Construct:
45 - Branch name: `learning/<YYYY-MM-DD>-<slug>`
46 - File path: `learned/<topic>/<YYYY-MM-DD>-<slug>.md`
47
488. Fork the groovebook repo if not already forked: `gh repo fork <groovebook> --clone=false`
49 - If fork already exists, skip silently
50
519. Create the branch and file:
52 - `gh api repos/<user-fork>/git/refs` to check if branch exists; if so, append a short unique suffix
53 - Write the file content (see format below) and commit via `gh api`
54 - Or: use `git` operations against the fork URL if `gh api` approach is too complex — prefer the simpler path
55
5610. Open the PR:
57 ```
58 gh pr create --repo <groovebook> \
59 --title "<one-sentence summary>" \
60 --body "<formatted body>" \
61 --head "<fork-user>:<branch-name>"
62 ```
63
6411. Print the PR URL
65
66## Learning file format
67
68```markdown
69---
70date: YYYY-MM-DD
71topic: <topic>
72skill-area: <skill-area>
73source: groovebook-publish
74---
75
76# <One-sentence summary>
77
78## Context
79
80<What triggered this learning — what problem were you solving? Generic, no project specifics.>
81
82## Learning
83
84<The insight itself — what to do, what to avoid, or what pattern works.>
85
86## Groove skill area
87
88`<skill-area>` (e.g. `groove-work-compound`, `groove-work-plan`)
89```
90
91## PR body format
92
93```
94## Summary
95<one-sentence summary>
96
97## Context
98<what triggered this>
99
100## Learning
101<the insight>
102
103## Groove skill area
104`<skill-area>`
105
106---
107*Published via groove-groovebook-publish*
108```
109
110## Constraints
111
112- Never publish learning text that contains project-specific names, file paths, or internal identifiers without explicit user confirmation that it's intentional
113- If the fork step fails due to permissions: suggest the user fork manually and set their fork as the `groovebook:` value
114- Slug must be safe for use as a filename: lowercase, hyphens only, no path separators or special characters
115- If branch already exists: append `-2`, `-3`, etc. until a free name is found