opencode-code-archaeology 2.0.2 → 2.2.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/.github/pull_request_template.md +1 -0
- package/.github/workflows/release.yml +46 -0
- package/AGENTS.md +42 -10
- package/CHANGELOG.md +59 -0
- package/CONTRIBUTING.md +2 -0
- package/INSTALL.md +90 -20
- package/README.md +90 -29
- package/VERSION +1 -1
- package/assets/code-archaeology-banner.svg +173 -44
- package/commands/code-archaeology.md +7 -5
- package/dist/cli.js +28 -2
- package/dist/cli.js.map +1 -1
- package/dist/index.d.ts +1 -5
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -17
- package/dist/index.js.map +1 -1
- package/dist/platform.d.ts +4 -0
- package/dist/platform.d.ts.map +1 -0
- package/dist/platform.js +11 -0
- package/dist/platform.js.map +1 -0
- package/dist/plugin.d.ts +2 -2
- package/dist/plugin.d.ts.map +1 -1
- package/dist/plugin.js +2 -1
- package/dist/plugin.js.map +1 -1
- package/dist/runtime.d.ts +18 -0
- package/dist/runtime.d.ts.map +1 -0
- package/dist/runtime.js +49 -0
- package/dist/runtime.js.map +1 -0
- package/dist/types.d.ts +1 -6
- package/dist/types.d.ts.map +1 -1
- package/dist/types.js.map +1 -1
- package/docs/ARCHITECTURE.md +41 -10
- package/docs/INSTALL.md +50 -11
- package/docs/README.md +37 -9
- package/docs/RELEASE.md +20 -16
- package/docs/index.html +740 -0
- package/hooks/hermes/runner.ps1 +247 -0
- package/hooks/hermes/runner.sh +262 -0
- package/hooks/hermes/setup.ps1 +41 -0
- package/hooks/hermes/setup.sh +41 -0
- package/hooks/opencode/init.ps1 +83 -0
- package/hooks/opencode/revert-phase.ps1 +12 -0
- package/hooks/opencode/revert-phase.sh +3 -8
- package/hooks/opencode/update-expedition.ps1 +51 -0
- package/hooks/opencode/verify-package.sh +1 -0
- package/hooks/opencode/verify-phase.ps1 +35 -0
- package/hooks/opencode/verify-phase.sh +7 -7
- package/hooks/shared/command-utils.ps1 +100 -0
- package/package.json +16 -2
- package/skills/code-archaeology/SKILL.md +2 -2
- package/skills/hermes/INTEGRATION.md +120 -0
- package/skills/hermes/README.md +167 -0
- package/skills/hermes/code-archaeology-prompt.md +203 -0
- package/wiki/Expedition-Workflow.md +3 -1
- package/wiki/Home.md +2 -2
- package/wiki/Installation.md +2 -0
- package/wiki/Release-Process.md +5 -5
- package/plugins/code-archaeology.ts +0 -8
package/docs/RELEASE.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Release Process
|
|
2
2
|
|
|
3
|
-
This checklist is for future `opencode-code-archaeology` releases. `v2.0
|
|
3
|
+
This checklist is for future `opencode-code-archaeology` releases. `v2.1.0` is the current release example; replace it with the next version when preparing a new release.
|
|
4
4
|
|
|
5
5
|
## 1. Preflight
|
|
6
6
|
|
|
@@ -12,23 +12,23 @@ This checklist is for future `opencode-code-archaeology` releases. `v2.0.2` is t
|
|
|
12
12
|
|
|
13
13
|
## 2. Version Bump
|
|
14
14
|
|
|
15
|
-
For a future release, replace `2.0
|
|
15
|
+
For a future release, replace `2.1.0` with the target version:
|
|
16
16
|
|
|
17
17
|
```bash
|
|
18
|
-
npm version 2.0
|
|
18
|
+
npm version 2.1.0 --no-git-tag-version
|
|
19
19
|
```
|
|
20
20
|
|
|
21
21
|
Update `VERSION` to the same value:
|
|
22
22
|
|
|
23
23
|
```text
|
|
24
|
-
2.0
|
|
24
|
+
2.1.0
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
Confirm `package.json`, `package-lock.json`, and `VERSION` agree.
|
|
28
28
|
|
|
29
29
|
## 3. Changelog
|
|
30
30
|
|
|
31
|
-
- Add a `v2.0
|
|
31
|
+
- Add a `v2.1.0` entry, or the future target version, to `CHANGELOG.md`.
|
|
32
32
|
- Include user-visible changes, safety notes, and any migration instructions.
|
|
33
33
|
- Keep the release notes factual and avoid claiming publication steps that have not happened yet.
|
|
34
34
|
|
|
@@ -43,6 +43,7 @@ npm run typecheck
|
|
|
43
43
|
npm audit --audit-level=moderate
|
|
44
44
|
npm outdated --json
|
|
45
45
|
bash -n hooks/opencode/*.sh
|
|
46
|
+
bash -n hooks/hermes/*.sh
|
|
46
47
|
npm pack --json --dry-run
|
|
47
48
|
```
|
|
48
49
|
|
|
@@ -51,7 +52,7 @@ Expected outcomes:
|
|
|
51
52
|
- Build and typecheck pass.
|
|
52
53
|
- npm audit reports no moderate-or-higher vulnerabilities.
|
|
53
54
|
- npm outdated reports `{}` or no actionable outdated dependencies.
|
|
54
|
-
- Shell hooks pass syntax checks.
|
|
55
|
+
- Shell hooks pass syntax checks (both OpenCode and Hermes).
|
|
55
56
|
- The package dry run includes required files.
|
|
56
57
|
|
|
57
58
|
## 5. npm Pack Required Files
|
|
@@ -63,7 +64,6 @@ Inspect `npm pack --json --dry-run` output for the package contents. Required fi
|
|
|
63
64
|
- `hooks/`
|
|
64
65
|
- `commands/`
|
|
65
66
|
- `skills/`
|
|
66
|
-
- `plugins/`
|
|
67
67
|
- `schema/`
|
|
68
68
|
- `prompts/`
|
|
69
69
|
- `docs/`
|
|
@@ -77,6 +77,8 @@ Inspect `npm pack --json --dry-run` output for the package contents. Required fi
|
|
|
77
77
|
- `SECURITY.md`
|
|
78
78
|
- `LICENSE`
|
|
79
79
|
|
|
80
|
+
`plugins/` is intentionally repo-local and should not appear in npm package contents.
|
|
81
|
+
|
|
80
82
|
If any required file is missing, update the `files` array in `package.json`, rerun `npm install` if the lockfile needs to change, and repeat the package dry run.
|
|
81
83
|
|
|
82
84
|
## 6. Commit, Tag, And Push
|
|
@@ -86,10 +88,10 @@ Only perform these steps after verification passes and after confirming the bran
|
|
|
86
88
|
```bash
|
|
87
89
|
git status --short
|
|
88
90
|
git add README.md INSTALL.md docs wiki assets .github SECURITY.md CONTRIBUTING.md CHANGELOG.md package.json package-lock.json VERSION .gitignore
|
|
89
|
-
git commit -m "chore: prepare v2.0
|
|
90
|
-
git tag v2.0
|
|
91
|
+
git commit -m "chore: prepare v2.1.0 release"
|
|
92
|
+
git tag v2.1.0
|
|
91
93
|
git push origin HEAD
|
|
92
|
-
git push origin v2.0
|
|
94
|
+
git push origin v2.1.0
|
|
93
95
|
```
|
|
94
96
|
|
|
95
97
|
For a future release, use the future version in the commit message and tag.
|
|
@@ -99,18 +101,20 @@ For a future release, use the future version in the commit message and tag.
|
|
|
99
101
|
Create the GitHub release from the matching tag:
|
|
100
102
|
|
|
101
103
|
```bash
|
|
102
|
-
gh release create v2.0
|
|
104
|
+
gh release create v2.1.0 --title "v2.1.0" --notes-file CHANGELOG.md
|
|
103
105
|
```
|
|
104
106
|
|
|
105
107
|
Before publishing, trim the notes to the specific version section if `CHANGELOG.md` contains multiple releases.
|
|
106
108
|
|
|
107
109
|
## 8. npm Publish
|
|
108
110
|
|
|
109
|
-
|
|
111
|
+
Publishing is performed by `.github/workflows/release.yml` through npm trusted publishing. Configure npm Trusted Publisher with:
|
|
110
112
|
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
113
|
+
- Publisher: `GitHub Actions`
|
|
114
|
+
- Organization or user: `Maleick`
|
|
115
|
+
- Repository: `Code-Archaeology`
|
|
116
|
+
- Workflow filename: `release.yml`
|
|
117
|
+
- Environment name: leave blank unless the workflow adds a GitHub Actions `environment`
|
|
114
118
|
|
|
115
119
|
If publishing fails, do not create a replacement tag unless the failure requires a new package version. Fix the issue, rerun verification, and follow npm versioning rules.
|
|
116
120
|
|
|
@@ -121,7 +125,7 @@ Confirm the public release surfaces report the expected version:
|
|
|
121
125
|
```bash
|
|
122
126
|
npm view opencode-code-archaeology version
|
|
123
127
|
npm view opencode-code-archaeology dist-tags
|
|
124
|
-
gh release view v2.0
|
|
128
|
+
gh release view v2.1.0
|
|
125
129
|
```
|
|
126
130
|
|
|
127
131
|
Optionally verify a fresh install path:
|