Skip to content

Commit 527f289

Browse files
committed
Finalize v0.1.0 release prerequisites
1 parent fbbd5f1 commit 527f289

8 files changed

Lines changed: 82 additions & 20 deletions

CHANGELOG.md

Lines changed: 6 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,11 @@ All notable changes to ContextForge will be documented in this file.
44

55
## Unreleased
66

7-
### Release-candidate scope
7+
- No unreleased changes tracked yet.
8+
- The `0.1.0` entry below reflects the prepared release contents. GitHub Release creation and npm publish still happen only after the maintainer dispatches the release workflow successfully.
89

9-
- Local-first CLI for repository scan/init, task-pack compilation from markdown or GitHub issue sources, and task-brief exports for Codex, Claude Code, and Cursor.
10-
- Packaged CLI smoke validation, deterministic fixture evals, and release-candidate maintainer checks.
11-
- Checked-in demo artifacts under `examples/demo/` for first-time readers.
12-
- Manual publish dry-run and package-content sanity checks for first npm release preparation.
13-
- Bootstrap-era root PRD archived under `docs/archive/bootstrap/` so `docs/product/` stays the public source of truth.
14-
- Versioned release artifact bundles under `.contextforge/releases/<version>/` for manual release handoff.
15-
- English and Simplified Chinese READMEs plus lightweight SVG diagrams for first-visit onboarding.
16-
- Internal milestone Codex prompts archived out of `.github/codex/prompts/` so the default Codex output directory stays clean.
17-
- GitHub issue and pull request templates plus lightweight contributing, security, and triage docs for early external users.
18-
- Manual-dispatch release automation for repo metadata sync, GitHub Release creation, npm publish, and post-release verification.
10+
## 0.1.0
1911

20-
### Notes
21-
22-
- No npm package has been published from this changelog yet.
23-
- Version selection and changelog readiness remain explicit maintainer decisions before any workflow dispatch.
12+
- Local-first CLI for repository scan/init, task-pack compilation from markdown or GitHub issue sources, and compact exports for Codex, Claude Code, and Cursor.
13+
- Stale-context linting plus deterministic fixture evals, packaged smoke validation, publish dry-run, and release-candidate checks.
14+
- Checked-in demo assets, bilingual README onboarding, community contribution templates, and manual-dispatch release automation for the first public release path.

docs/maintainers/first-public-release-checklist.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,18 @@ Recommended defaults for a normal public release:
2525
- `sync_repo_metadata`: `true`
2626
- `prerelease`: `false`
2727

28+
For the first live public release, use these exact values:
29+
30+
- `version = 0.1.0`
31+
- `npm_tag = latest`
32+
- `publish_to_npm = true`
33+
- `create_github_release = true`
34+
- `sync_repo_metadata = true`
35+
- `prerelease = false`
36+
2837
## After the workflow finishes
2938

3039
- verify the GitHub Release exists and includes the tarball plus checksums
3140
- verify the npm package page shows the expected version and README
3241
- review GitHub About text, topics, and homepage
3342
- spot-check the install and quickstart flow from the published package
34-

docs/maintainers/first-public-release.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Use this guide when ContextForge is ready for its first public release candidate or first published release.
44

5-
If you want the shortest actionable list, start with `docs/maintainers/first-public-release-checklist.md`. Use this document for the surrounding context and decision points.
5+
If you want the shortest actionable list, start with `docs/maintainers/first-public-release-checklist.md`. Use `docs/maintainers/live-release-prerequisites.md` for the exact first live dispatch values and external setup. Use this document for the surrounding context and decision points.
66

77
## What should already be true
88

@@ -40,6 +40,15 @@ npm run release:artifacts
4040

4141
When the version, changelog, permissions, and npm setup are ready, trigger the release workflow in GitHub Actions instead of recreating the publish steps by hand.
4242

43+
For the first live public release, the recommended workflow-dispatch values are:
44+
45+
- `version = 0.1.0`
46+
- `npm_tag = latest`
47+
- `publish_to_npm = true`
48+
- `create_github_release = true`
49+
- `sync_repo_metadata = true`
50+
- `prerelease = false`
51+
4352
## Inspect the demo assets
4453

4554
Review the files in `examples/demo/` before publishing:
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Live release prerequisites
2+
3+
Use this before triggering `.github/workflows/release.yml` for the first real public release.
4+
5+
## External setup required
6+
7+
- GitHub Actions workflow permissions must allow read and write access so `github.token` can create tags and GitHub Releases.
8+
- `REPO_METADATA_TOKEN` is needed if you want the workflow to sync repository description, homepage, and topics.
9+
- Reason: editing repo metadata usually needs broader repo settings permission than `github.token` provides.
10+
- npm trusted publishing should be configured for this repository if you want tokenless publish from GitHub Actions.
11+
- If npm trusted publishing is not configured, create the repository secret `NPM_TOKEN` as the fallback publish credential.
12+
13+
## First live dispatch values
14+
15+
For the first public release, use:
16+
17+
- `version = 0.1.0`
18+
- `npm_tag = latest`
19+
- `publish_to_npm = true`
20+
- `create_github_release = true`
21+
- `sync_repo_metadata = true`
22+
- `prerelease = false`
23+
24+
## Before dispatch
25+
26+
- `CHANGELOG.md` contains the `0.1.0` entry.
27+
- `package.json` version is `0.1.0`.
28+
- `npm run release:check` passes locally.
29+
- `npm run release:artifacts` has generated the current bundle under `.contextforge/releases/0.1.0/`.
30+
- `.github/release/repo-metadata.json` matches the intended public metadata.
31+
32+
## After the workflow finishes
33+
34+
- verify the GitHub Release exists and includes the tarball plus checksums
35+
- verify the published npm version is `0.1.0`
36+
- verify the npm package page renders the README and links correctly
37+
- verify GitHub About text, homepage, and topics match `.github/release/repo-metadata.json`
38+

docs/maintainers/manual-release-handoff.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Check that it:
4343
After reviewing the bundle:
4444

4545
1. make sure `.github/release/repo-metadata.json`, `package.json`, and `CHANGELOG.md` are ready in git
46-
2. confirm the release workflow permissions and secrets described in `docs/maintainers/release-automation.md`
46+
2. confirm the release workflow permissions and secrets described in `docs/maintainers/release-automation.md` and `docs/maintainers/live-release-prerequisites.md`
4747
3. trigger the manual-dispatch release workflow
4848
4. if metadata sync or npm publish credentials are not configured, complete only those missing steps manually
4949
5. verify the GitHub Release and npm package page after publish

docs/maintainers/npm-publish-guide.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,12 @@ If trusted publishing is not available yet:
2828

2929
The workflow will then publish using token auth instead of trusted publishing.
3030

31+
For the first live public release, keep these workflow inputs:
32+
33+
- `version = 0.1.0`
34+
- `npm_tag = latest`
35+
- `publish_to_npm = true`
36+
3137
## Safety notes
3238

3339
- never print or commit npm tokens
@@ -42,4 +48,3 @@ After the workflow publishes:
4248
- confirm `npm view contextforge@<version> version` returns the expected version
4349
- verify the npm package page renders `README.md` correctly
4450
- verify homepage, repository, bugs, and license links
45-

docs/maintainers/release-automation.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ ContextForge ships a manual-dispatch release workflow at `.github/workflows/rele
44

55
It does not run on push. A maintainer must dispatch it explicitly with the target version.
66

7+
For the first live public release, see `docs/maintainers/live-release-prerequisites.md` for the exact dispatch values and required external setup.
8+
79
## What the workflow does
810

911
When configured correctly, the workflow:
@@ -59,10 +61,18 @@ Secrets:
5961
4. dispatch the workflow with the matching version
6062
5. review the GitHub Release and npm package page after it finishes
6163

64+
Recommended first live dispatch:
65+
66+
- `version = 0.1.0`
67+
- `npm_tag = latest`
68+
- `publish_to_npm = true`
69+
- `create_github_release = true`
70+
- `sync_repo_metadata = true`
71+
- `prerelease = false`
72+
6273
## What remains outside repo automation
6374

6475
- deciding the version to release
6576
- writing or curating final changelog content
6677
- configuring GitHub workflow permissions
6778
- configuring repo metadata token or npm publishing setup
68-

docs/maintainers/release-checklist.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ Before a first public release, review:
6767
- `docs/maintainers/public-metadata-checklist.md`
6868
- `docs/maintainers/manual-release-handoff.md`
6969
- `docs/maintainers/release-automation.md`
70+
- `docs/maintainers/live-release-prerequisites.md`
7071
- `docs/maintainers/npm-publish-guide.md`
7172

7273
## Manual publish boundary

0 commit comments

Comments
 (0)