Skip to content

Commit 0268090

Browse files
committed
fix: update doc-freshness skill to use correct release workflow
1 parent 29aa3b7 commit 0268090

1 file changed

Lines changed: 44 additions & 9 deletions

File tree

.claude/skills/doc-freshness/SKILL.md

Lines changed: 44 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ These are the repos whose changes may require documentation updates.
2828
| devops-ansible-inventory | `megaeth-labs/devops-ansible-inventory` | Network parameter changes (chain IDs, RPC URLs, explorer URLs), new network deployments, config changes |
2929
| mega-op-contracts | `megaeth-labs/mega-op-contracts` | Bridge contract changes, L1/L2 interface changes, system config changes, new dispute game types |
3030
| mega-optimism | `megaeth-labs/mega-optimism` | Sequencer behavior changes, payload building changes, L1 settlement changes |
31-
| dist-docs | `megaeth-labs/dist-docs` | Release tags — determines which mega-reth changes are live and doc-worthy. Not scanned for PRs; used only to identify the latest released version. |
31+
| dist-docs | `megaeth-labs/dist-docs` | Release notes and hardfork schedules — determines which mega-reth changes are released (via merged `chore: release vX.Y.Z` PRs) and which mega-evm hardforks are active (via genesis config timestamps). Not scanned for code changes. |
3232

3333
## Workflow
3434

@@ -53,19 +53,54 @@ For each PR, record:
5353
- Labels (if any)
5454
- A one-line summary of what changed (from PR title or body)
5555

56-
### Phase 1.5: Determine Latest Released Version (mega-reth)
56+
### Phase 1.5: Determine Release Status
5757

58-
For mega-reth, only changes included in the **latest released version** should be considered for new behavior or behavior changes.
59-
PRs merged after the latest release are unreleased and should not drive documentation updates yet.
58+
#### Part A: Latest Released mega-reth Version
6059

61-
1. **Check the dist-docs repo** for the latest release tag:
60+
Check mega-reth GitHub Releases for the latest version and release date:
61+
62+
```bash
63+
gh release list --repo megaeth-labs/mega-reth --limit 5
64+
```
65+
66+
Cross-reference with dist-docs to confirm the release has been announced to external partners:
67+
68+
```bash
69+
gh pr list --repo megaeth-labs/dist-docs --state merged --search "release {version} in:title" --json number,title,mergedAt --limit 1
70+
```
71+
72+
If a mega-reth release exists but has no corresponding dist-docs PR, note it as "Released but not yet announced — pending dist-docs release note."
73+
Only mega-reth changes included in a version that has been both released **and** announced via dist-docs should be considered doc-worthy.
74+
PRs merged after the latest announced release should be excluded and noted as "Unreleased — pending next release."
75+
76+
As a fallback, dist-docs version files follow the naming pattern `versions/{date}-v{version}.m4` and can be listed via:
77+
78+
```bash
79+
gh api repos/megaeth-labs/dist-docs/contents/versions --jq '.[].name' | sort | tail -5
80+
```
81+
82+
#### Part B: Hardfork Activation Gating
83+
84+
Some mega-evm spec changes are tied to a named hardfork and should only be made public in documentation after the hardfork activates on mainnet.
85+
86+
1. **Check dist-docs release notes** for hardfork mentions:
6287
```bash
63-
gh release list --repo megaeth-labs/dist-docs --limit 5
88+
gh pr list --repo megaeth-labs/dist-docs --state merged --search "hardfork in:body" --json number,title,body,mergedAt --limit 5
6489
```
65-
2. **Identify the release date and tag** (e.g., `v0.6.0`, `2026-03-20`).
66-
3. **Filter mega-reth PRs**: only include PRs merged on or before the release date. PRs merged after the latest release should be excluded from the doc-worthy triage and noted as "Unreleased — pending next release" in the report.
6790

68-
This does not apply to mega-rpc (deployed continuously) or mega-evm (spec changes are doc-worthy regardless of release).
91+
2. **Extract the hardfork name and mainnet activation timestamp** from the release note body.
92+
93+
3. **Compare activation timestamp against current time**:
94+
- If **activated** (timestamp in the past): mega-evm spec changes for this hardfork are doc-worthy and can be made public.
95+
- If **not yet activated** (timestamp in the future): note as "Hardfork {name} not yet active — activates {date}. Defer public documentation."
96+
97+
#### Scope
98+
99+
- **mega-reth**: gated by mega-reth GitHub Releases + dist-docs announcement to external partners.
100+
- **mega-evm**: spec changes tied to a named hardfork are gated by hardfork activation time; tooling changes (like mega-evme CLI flags) are doc-worthy regardless of hardfork status.
101+
- **mega-rpc**: deployed continuously, not gated.
102+
103+
---
69104

70105
### Phase 2: Triage — Doc-Worthy vs Internal
71106

0 commit comments

Comments
 (0)