Skip to content

Commit dca3f79

Browse files
committed
ci: claim the Context7 library and refresh it
Context7 indexed this repository on October 8, 2026. A claimed library has an admin panel and higher refresh limits, and Context7 verifies the claim through the url and public_key in context7.json. The public_key is the maintainer's public account key, which Context7 designs to be committed. Add a workflow that asks Context7 to refresh the index after each push to main that changes the README, context7.json, docs/, or examples/. The release docs no longer ask for a manual refresh. The workflow's request was run locally against the API and returned "Refresh started successfully". It reads the CONTEXT7_API_KEY repository secret, which is set.
1 parent 3f409da commit dca3f79

4 files changed

Lines changed: 43 additions & 2 deletions

File tree

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: Context7 refresh
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
paths:
8+
- "README.md"
9+
- "context7.json"
10+
- "docs/**"
11+
- "examples/**"
12+
13+
permissions:
14+
contents: read
15+
16+
jobs:
17+
refresh:
18+
runs-on: ubuntu-latest
19+
timeout-minutes: 5
20+
steps:
21+
- name: Trigger a Context7 refresh
22+
env:
23+
CONTEXT7_API_KEY: ${{ secrets.CONTEXT7_API_KEY }}
24+
LIBRARY_NAME: /${{ github.repository }}
25+
run: |
26+
curl --fail --silent --show-error --max-time 60 \
27+
-X POST https://context7.com/api/v1/refresh \
28+
-H "Content-Type: application/json" \
29+
-H "Authorization: Bearer $CONTEXT7_API_KEY" \
30+
-d "{\"libraryName\": \"$LIBRARY_NAME\"}"

‎CHANGELOG.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# Changelog
22

3+
## Unreleased
4+
5+
- Claim the Context7 library: `context7.json` now carries the library `url` and
6+
the maintainer `public_key`.
7+
- Add the Context7 refresh workflow. A push to `main` that changes the README,
8+
`context7.json`, `docs/`, or `examples/` asks Context7 to refresh the index.
9+
It uses the `CONTEXT7_API_KEY` repository secret.
10+
311
## 0.17.1 - 2026-10-08
412

513
- Check holds with `Object.hasOwn` in the README and guide ticket sale

‎context7.json‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
{
22
"$schema": "https://context7.com/schema/context7.json",
3+
"url": "https://context7.com/cardmagic/solid-objects-js",
4+
"public_key": "pk_veEo2smPvGYMwP1MncN1A",
35
"projectTitle": "Solid Objects for TypeScript and Node.js (solid-objects)",
46
"description": "SQL-backed virtual actor library for TypeScript and Node.js. Actors have stable identities, durable JSON state in SQLite, PostgreSQL, or MySQL, ordered per-identity mailboxes, fenced activation, durable reminders, and transactional effects. Requires Node.js 24.4+; ESM only.",
57
"folders": ["docs", "examples"],

‎docs/releasing.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,5 +60,6 @@ npm already holds, it still creates a missing release.
6060

6161
After the tag publishes, refresh the solidobjects.dev documentation snapshot
6262
from the tag and redeploy the site. The site's `check:release` step refuses a
63-
snapshot that is not the latest published tag. Then trigger a Context7 refresh
64-
for this repository.
63+
snapshot that is not the latest published tag. The Context7 refresh workflow
64+
refreshes the index after each push to `main` that changes the documentation.
65+
Confirm that its run succeeded.

0 commit comments

Comments
 (0)