Problem / context
orfe needs a repeatable package release process, but the publication target and package metadata must align with the actual distribution model.
This work is for publishing orfe to GitHub Packages rather than the public npm registry, updating package metadata for that target, and automating releases so published public package versions can be installed and used consistently.
Desired outcome
orfe is published to GitHub Packages through a documented and repeatable release process, with package metadata configured correctly for that registry and published versions installable through the supported public GitHub Packages flow.
Scope
In scope
- implement the confirmed package publishing target for
orfe: GitHub Packages (https://npm.pkg.github.com)
- update
package.json package name to the scoped package name @throw-if-null/orfe
- add
publishConfig in package.json for the GitHub Packages registry
- change the package license in
package.json from "UNLICENSED" to "MIT"
- remove
"docs" from the files array in package.json so only dist/ and README.md are published
- configure the repository for public GitHub Packages publication
- add a release/publish workflow for the package
- ensure the release process builds and validates the package before publication
- document the release procedure and supported public install/invocation paths for GitHub Packages
- validate that a published version can be installed from GitHub Packages and invoked via
orfe --help
Out of scope
- initial package structure and CLI entrypoint correctness beyond what is needed for publication
- repo-local config scaffolding
- machine-local auth config setup helpers or wizards
orfe config command design or implementation
- broader release management policy unrelated to package distribution
Acceptance criteria
Docs impact
- Docs impact: update existing docs
- Details: add GitHub Packages publish/release documentation, public install/invocation guidance, and any package-content notes needed for consumers
ADR needed?
- ADR needed: no
- Details: package publication and release automation do not change the core architecture
Dependencies / sequencing notes
Risks / open questions / non-goals
- GitHub Packages visibility, permissions, and public install behavior must be confirmed as part of this work.
- Release workflow design may require separate decisions about tagging or versioning if those are not already established.
- This issue is about package distribution and release automation, not the underlying auth/config UX.
Problem / context
orfeneeds a repeatable package release process, but the publication target and package metadata must align with the actual distribution model.This work is for publishing
orfeto GitHub Packages rather than the public npm registry, updating package metadata for that target, and automating releases so published public package versions can be installed and used consistently.Desired outcome
orfeis published to GitHub Packages through a documented and repeatable release process, with package metadata configured correctly for that registry and published versions installable through the supported public GitHub Packages flow.Scope
In scope
orfe: GitHub Packages (https://npm.pkg.github.com)package.jsonpackage name to the scoped package name@throw-if-null/orfepublishConfiginpackage.jsonfor the GitHub Packages registrypackage.jsonfrom"UNLICENSED"to"MIT""docs"from thefilesarray inpackage.jsonso onlydist/andREADME.mdare publishedorfe --helpOut of scope
orfe configcommand design or implementationAcceptance criteria
orfepackage.jsonuses the scoped package name@throw-if-null/orfepackage.jsonincludespublishConfigtargetinghttps://npm.pkg.github.compackage.jsonlicense is set toMIT"docs"is removed from thefilesarray inpackage.jsondist/andREADME.md(nodocs/)npm install @throw-if-null/orfe --registry=https://npm.pkg.github.comand invoked withorfe --helpnpx @throw-if-null/orfe --helpDocs impact
ADR needed?
Dependencies / sequencing notes
orfeas an installable npm CLI #24 is resolvedRisks / open questions / non-goals