Skip to content

GN-177: Prepare the move to glassnode/glassnode-terminal - #25

Merged
planadecu merged 2 commits into
mainfrom
GN-177-prepare-glassnode-org-move
Oct 5, 2026
Merged

planadecu merged 2 commits into
mainfrom
GN-177-prepare-glassnode-org-move

Conversation

@planadecu

@planadecu planadecu commented Oct 2, 2026 •

Copy link
Copy Markdown
Collaborator

What changed

This prepares the repository for its move to github.com/glassnode/glassnode-terminal, following the same steps as glassnode-api's move to glassnode/glassnode-api-ts-client (its commits e740aab, 0913123 and 4c35dad). Tracked in GN-177.

Repo identity and licensing

  • package.json: repository, bugs and homepage point to glassnode/glassnode-terminal, and Glassnode AG is listed under contributors.
  • package.json: publishConfig gains provenance: true and drops the forced tag: latest, so the dist-tag guard decides the tag.
  • Version 0.2.2.
  • LICENSE: the official Apache-2.0 text. The appendix copyright line now reads Jordi Planadecursach and Glassnode AG. NOTICE names both, plus the original author.
  • README: npm, CI and license badges, the org clone URL, a Contributing section, and a note that versions before 0.2.0 were MIT.
  • New files: CONTRIBUTING.md (PR flow, checks, versioning, releases, security, licensing of contributions), CHANGELOG.md (0.1.0 to 0.2.2) and .nvmrc (Node 24).

Release flow, ported from glassnode-api

  • publish.yml no longer publishes on tag pushes. On a merge to main, it:

    1. runs ci.yml (verify)
    2. checks read-only whether package.json's version is already on npm (release)
    3. waits for approval in the npm environment, publishes with Trusted Publishing and provenance, pushes v<version> and creates the GitHub Release from the CHANGELOG.md section (publish)

    It never pushes to main. A newer version can't move npm's latest backwards, and versions that were skipped get flagged.

  • The publish job only runs in glassnode/glassnode-terminal. That blocks forks, and blocks this repo before the transfer, where no protected npm environment exists.

  • scripts/release-state.sh, release-plan.mjs and check-changelog-heading.mjs, and their tests (test/release-scripts.spec.ts) started from glassnode-api. The heading check additionally enforces a version greater than the exact PR base commit and nonempty release notes for PRs into main; release-branch PRs are exempt. Tests cover unchanged, lower and metadata-only versions, empty notes, and the release-branch exception.

  • ci.yml is now callable by publish.yml, also runs on PRs into release/**, checks the CHANGELOG.md heading, and pins every action by SHA (the same SHAs as glassnode-api).

  • CLAUDE.md gains Versioning, CI and Publishing sections.

Migration status

Repository transferred to glassnode/glassnode-terminal. Main and release-branch rulesets are active, requiring test (22) and test (24). The npm environment requires approval by planadecu (no admin bypass), and allows the main branch only. Private vulnerability reporting is enabled; Dependabot alerts and GitGuardian are active. Local origin now points to the org repository.

Trusted Publisher is configured for glassnode/glassnode-terminal, publish.yml, environment npm, with publishing permission; the old connection is removed. PR merged as 955d98fdc9ab1c454fd931b40354fc9372db9824. Release workflow 37307283892 passed all jobs, published 0.2.2 with signed provenance, and created v0.2.2. npm accepted the package and is processing it before registry availability.

Original transfer checklist

This PR bumps to 0.2.2, the first release from the org repo.

Transfer checklist (GN-177)

  1. Transfer the repo: Settings → Danger zone → Transfer → glassnode, keeping the name glassnode-terminal. History, issues, PRs (including this one) and stars move, and GitHub redirects the old URLs.
  2. Rulesets (copy them from glassnode-api-ts-client):
    • Protect main: no direct pushes or force pushes, PRs only, with required checks test (22) and test (24).
    • Protect release branches: the same rules for release/**.
  3. The npm environment: Settings → Environments → npm. Add the maintainer as a required reviewer, and set the deployment branches to main only.
  4. npm Trusted Publisher: on npmjs.com, package glassnode-terminal → Settings → Trusted Publisher → GitHub Actions. Set repository glassnode/glassnode-terminal, workflow publish.yml, environment npm. Remove the old planadecu/glassnode-terminal entry.
  5. Security settings: enable private vulnerability reporting, and check that Dependabot and GitGuardian are active on the org repo.
  6. Merge this PR, then approve the publish job. 0.2.2 goes out with provenance, followed by the v0.2.2 tag and its GitHub Release.
  7. Locally: git remote set-url origin https://github.com/glassnode/glassnode-terminal.git.

Verification

  • tsc passes and 94 tests pass, including the 45 release-script tests from glassnode-api.
  • actionlint finds no problems in both workflows.
  • The build and the CLI smoke test pass.
  • check-changelog-heading.mjs accepts ## 0.2.2 for both main and release/**.
  • A dry run of scripts/release-state.sh against the live npm registry gives action=publish, dist_tag=latest and current latest 0.2.0.
  • npm pack --dry-run contains LICENSE, NOTICE, README.md and dist/.
  • LICENSE differs from apache.org's text only in the two copyright lines.
  • Approval-gated publish verified after transfer: all release workflow jobs passed, including OIDC publish, provenance, tag and GitHub Release creation.

Impact

For users: no behaviour change. The package name stays glassnode-terminal, and its metadata links point to the org repo. For contributors: every PR now bumps the version and adds a CHANGELOG.md entry, and CI enforces the version increase and nonempty release notes for PRs into main.

planadecu and others added 2 commits October 2, 2026 09:55
Same as glassnode-api's move to glassnode/glassnode-api-ts-client:

- package.json: repository/bugs/homepage -> glassnode/glassnode-terminal,
  Glassnode AG under contributors, publishConfig.provenance (no forced tag),
  version 0.2.1.
- LICENSE appendix names Jordi Planadecursach and Glassnode AG (otherwise the
  official Apache-2.0 text); NOTICE likewise. README: badges, org links,
  Contributing section, MIT history.
- CONTRIBUTING.md, CHANGELOG.md (0.1.0-0.2.1), .nvmrc.
- Release flow ported from glassnode-api: publish.yml releases package.json's
  version on merges to main (verify via ci.yml, read-only release check,
  approval in the `npm` environment, Trusted Publishing with provenance, tag,
  GitHub Release from CHANGELOG). Only runs in glassnode/glassnode-terminal.
  scripts/release-state.sh, release-plan.mjs, check-changelog-heading.mjs and
  their tests come from glassnode-api unchanged (test made ESM-safe).
- ci.yml: workflow_call, release/** PRs, CHANGELOG heading check, actions
  pinned by SHA. CLAUDE.md: versioning, CI and publishing sections.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01PzJHgXssByMwBXH1PGbXCL
@planadecu
planadecu merged commit 955d98f into main Oct 5, 2026
4 of 5 checks passed
planadecu added a commit that referenced this pull request Oct 5, 2026
* GN-177: Prepare the move to glassnode/glassnode-terminal

Same as glassnode-api's move to glassnode/glassnode-api-ts-client:

- package.json: repository/bugs/homepage -> glassnode/glassnode-terminal,
  Glassnode AG under contributors, publishConfig.provenance (no forced tag),
  version 0.2.1.
- LICENSE appendix names Jordi Planadecursach and Glassnode AG (otherwise the
  official Apache-2.0 text); NOTICE likewise. README: badges, org links,
  Contributing section, MIT history.
- CONTRIBUTING.md, CHANGELOG.md (0.1.0-0.2.1), .nvmrc.
- Release flow ported from glassnode-api: publish.yml releases package.json's
  version on merges to main (verify via ci.yml, read-only release check,
  approval in the `npm` environment, Trusted Publishing with provenance, tag,
  GitHub Release from CHANGELOG). Only runs in glassnode/glassnode-terminal.
  scripts/release-state.sh, release-plan.mjs, check-changelog-heading.mjs and
  their tests come from glassnode-api unchanged (test made ESM-safe).
- ci.yml: workflow_call, release/** PRs, CHANGELOG heading check, actions
  pinned by SHA. CLAUDE.md: versioning, CI and publishing sections.

* GN-177: Enforce PR version bumps and release notes

---------
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant