Repository navigation
Prepare @bindist/client for publishing to npm - #2
Merged
Merged
Conversation
- publishConfig.access public, so the first publish of the scoped package doesn't fail or land as private - Fill in author, homepage, repository and bugs metadata - Give the ESM and CJS entry points their own type declarations (index.d.mts / index.d.ts) instead of pointing both at the CJS ones - prepublishOnly runs lint, typecheck and build - Release workflow: on a v* tag, check the tag matches package.json and run npm publish --provenance using the NPM_TOKEN secret - README: drop "(when published)" and fix the from-source steps Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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
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.
@bindist/clienthas never been published to npm. We already own the@bindistorg (which holds@bindist/dynamo-to-pg), so the name is ours. This PR gets the package ready to publish and adds a release workflow.Changes
publishConfig.access: public: npm publishes scoped packages as private by default, so without this the first publish would fail on a free org or end up private on a paid one.author,homepage(docs.bindist.eu/sdks/javascript),repositoryandbugs, and replaces the outdated description.exportstypes: ESM consumers were pointed at the CJSindex.d.ts. Each format now has its own types file (index.d.mtsfor import,index.d.tsfor require).prepublishOnly: runs lint, typecheck and build before any publish..github/workflows/release.yml: runs on av*tag, checks that the tag matches thepackage.jsonversion, then runsnpm publish --provenance.Before the first release
@bindistorg and add it to this repo as theNPM_TOKENsecret.1.0.0.main(for examplegit tag v1.0.0 && git push --tags).Testing
npm ci && npm run lint && npm run typecheck && npm run buildpasses locally.npm pack --dry-runlists the expected 7 files: the CJS/ESM builds, both.d.tsfiles, the README, the LICENSE andpackage.json.🤖 Generated with Claude Code