docs: add CHANGELOG and CI - #2
Merged
Merged
Conversation
Adds a GitHub Actions CI workflow (Node 24; npm ci, typecheck, test, build, npm pack --dry-run) following the house pattern used by match-kit, ring-sig and toll-kit. This repo has a private git dependency on @forgesworn/roost-kit, so the workflow also includes the Authenticate git for private @forgesworn deps step (FORGESWORN_READ_PAT) used elsewhere for private deps.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
CHANGELOG.mdin Keep a Changelog style, documenting the existingv0.1.0release retrospectively..github/workflows/ci.yml(Node 24;npm ci, typecheck, test, build,npm pack --dry-run), following the house pattern used by match-kit, ring-sig and toll-kit.Known gap
covey-kithas a private git dependency on@forgesworn/roost-kit(confirmed private). The workflow includes theAuthenticate git for private @forgesworn depsstep (same pattern assignet-app/deploy.yml), which reads repo secretFORGESWORN_READ_PAT. That secret is not yet provisioned onforgesworn/covey-kit(checked viagh secret list), so the hostednpm cistep is expected to fail fetching@forgesworn/roost-kituntil it is added — this is the known org-wide credential gap tracked separately, not a defect in this workflow.Test plan
npm ci && npm test && npm run typecheck && npm run build && npm pack --dry-runall pass locally (my local git already has SSH access to the private dependency).