You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
chore(skills): review README and repo about text on every release (#1429)
* chore(skills): review README and repo about text on every release
Add a "Repo about text" check to Step 5 of the /release skill so the
GitHub description and topics are reviewed each release, not just when
user-facing features change. Update the PR body template to include the
new checklist items.
* fix(skills): reinforce PUT /topics full-replace semantics and add about-changes placeholder (#1429)
Copy file name to clipboardExpand all lines: .claude/skills/release/SKILL.md
+41-3Lines changed: 41 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -161,7 +161,11 @@ Read `docs/roadmap/BACKLOG.md` and check if any backlog items were completed or
161
161
- Check the "Depends on" column of other items — if they depended on the newly completed item, note that they are now unblocked
162
162
- Update the `Last updated` date at the top of the file
163
163
164
-
## Step 5: Update README.md
164
+
## Step 5: Update README.md and repo "about" text
165
+
166
+
This step runs every release regardless of whether features changed.
167
+
168
+
### README.md
165
169
166
170
Read `README.md` and check if any new user-facing features from this release need to be documented:
167
171
@@ -175,7 +179,37 @@ Read `README.md` and check if any new user-facing features from this release nee
175
179
- Completed phases should keep their historical version markers (e.g., "Complete (v3.0.0)")
176
180
- This check runs every release, not only when phase status changes — drift accumulates silently
177
181
6.**Version references** — only update version-specific references (e.g., install commands). Historical milestone markers like "Complete (v3.0.0)" should stay as-is
178
-
7. If nothing user-facing changed (pure refactors, bug fixes, internal improvements), no README update is needed — **but still run the roadmap ordering cross-check (item 5)**
182
+
7. If nothing user-facing changed (pure refactors, bug fixes, internal improvements), no README content update is needed — **but still run the roadmap ordering cross-check (item 5)**
183
+
184
+
### Repo "about" text
185
+
186
+
Fetch the current GitHub repository metadata and review whether it still accurately describes the project:
187
+
188
+
```bash
189
+
gh api repos/optave/ops-codegraph-tool --jq '{description: .description, homepage: .homepage, topics: .topics}'
190
+
```
191
+
192
+
Check:
193
+
-**Description** — does the one-line repo description match what codegraph actually is and does today? Update if it's stale, vague, or missing newly supported languages/capabilities.
194
+
-**Topics/tags** — are the labels current? For example, if a new language was added this release, add it. Common topics to keep in sync: language names, `cli`, `code-analysis`, `dependency-graph`, `tree-sitter`, `sqlite`, `mcp`.
195
+
-**Homepage** — is the URL still correct?
196
+
197
+
If any field needs updating, apply it **directly via the API** (no file change needed — this is a GitHub metadata update, not a committed file):
198
+
199
+
```bash
200
+
# Update description and/or homepage
201
+
gh api --method PATCH repos/optave/ops-codegraph-tool \
202
+
-f description="NEW DESCRIPTION" \
203
+
-f homepage="https://..."
204
+
205
+
# Update topics — start from the fetched list above, then add/remove as needed.
206
+
# This PUT replaces ALL topics atomically; do NOT copy the example below verbatim —
207
+
# build the full list from the currently active topics first, then adjust.
208
+
gh api --method PUT repos/optave/ops-codegraph-tool/topics \
Note: "about" text changes are applied directly to GitHub — they don't require a commit. Record any changes made in the PR description so reviewers know what was updated.
179
213
180
214
## Step 6: Verify `libc` fields in package-lock.json
181
215
@@ -200,19 +234,23 @@ Place the `libc` array after the `cpu` array in each entry.
200
234
2. Stage only the files you changed: `CHANGELOG.md`, `docs/roadmap/ROADMAP.md`, `docs/roadmap/BACKLOG.md` if changed, `README.md` if changed, `package-lock.json` if libc fields were fixed
201
235
3. Commit: `docs: prepare release notes for vVERSION`
202
236
4. Push: `git push -u origin release/VERSION`
203
-
5. Create PR:
237
+
5. Create PR (include a note if repo "about" text was updated directly on GitHub):
- Add CHANGELOG entry for vVERSION (all commits since previous release)
209
243
- Update ROADMAP progress
244
+
- Review README and repo "about" text for accuracy
245
+
- Repo "about" updated: <!-- describe what changed (description / homepage / topics), or "no changes needed" -->
210
246
211
247
**After merging:** create a GitHub Release with tag `vVERSION` to trigger the publish workflow, which handles version bumping, native binary builds, and npm publishing.
212
248
213
249
## Test plan
214
250
- [ ] CHANGELOG renders correctly on GitHub
215
251
- [ ] ROADMAP checklist items match actual codebase state
252
+
- [ ] README roadmap order matches ROADMAP.md
253
+
- [ ] Repo "about" description and topics are current
0 commit comments