First npm release of @bitpin-dev/bitpin-sdk: manual publish + trusted publisher
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 15/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- github-actions, typescript
Research direction
Read the release workflow release.yml and the CI-built archive bitdev-pin-bitpin-sdk-0.1.1.tgz referenced in the issue. Merge the “release ts 0.1.1” PR, wait for build-ts, then follow the listed npm trusted-publishing and access settings steps. Done when 0.1.1 is published, trusted publishing is configured, the waiting job is rejected, and the old unscoped package is unpublished.
Written by the indexing model from the issue text.
Description
The TypeScript SDK is published as @bitpin-dev/bitpin-sdk, a scoped package that belongs to the bitpin-dev npm organization (#20). The release workflow publishes with npm trusted publishing (OIDC, with provenance) from the npm environment; no npm token is stored.
npm can only add a trusted publisher to a package that exists, so the first version is published by hand once:
- npm organization
bitpin-dev, 2FA on - GitHub environment
npmwith required reviewers - Merge the "release ts 0.1.1" PR; let
build-tsfinish and leavepublish-tswaiting - Publish the CI-built package by hand, as a member of
bitpin-dev:npm publish bitpin-dev-bitpin-sdk-0.1.1.tgz --access public - npmjs.com →
@bitpin-dev/bitpin-sdk→ Settings → Trusted publishing → GitHub Actions:bitpin-dev/bitpin-sdk/release.yml/ environmentnpm - Settings → Publishing access → "Require two-factor authentication and disallow tokens"
- Reject the waiting
publish-tsjob (0.1.1 is already out) - Unpublish the old unscoped
bitpin-sdkfrom the personal account:npm unpublish bitpin-sdk --force(allowed within 72 hours of publishing)
After that, every ts-vX.Y.Z release publishes automatically once someone approves the npm environment.
- Dominant language
- Python
- Stars
- 0
- Forks
- 0
- Avg merge
- 28m
- Merged PRs (30d)
- 20
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from bitpin-dev/bitpin-sdk
-
documentation java release
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
bitpin-dev/bitpin-sdk#32 ·
Maintainers usually reply within 1 day
-
docs help wanted i18n
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
bitpin-dev/bitpin-sdk#8 ·
Maintainers usually reply within 1 day
-
enhancement go java websocket
Difficulty 4/5 3-5 days Newbie friendliness 52/100
bitpin-dev/bitpin-sdk#33 ·
Maintainers usually reply within 1 day
-
enhancement java
Difficulty 3/5 1-2 days Newbie friendliness 70/100
bitpin-dev/bitpin-sdk#31 ·
Maintainers usually reply within 1 day
-
bug python security
Difficulty 4/5 3-5 days Newbie friendliness 55/100
bitpin-dev/bitpin-sdk#30 ·
Maintainers usually reply within 1 day
All issues in bitpin-dev/bitpin-sdk
Similar issues
-
Context/namespace resources fail in-cluster: "Invalid kube-config file. No configuration found."Open
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
bug documentation
Difficulty 1/5 Under an hour Newbie friendliness 88/100
awslabs/visual-asset-management-system#880 ·
Maintainers usually reply within 1 day
-
netbox status: needs owner type: documentation
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
netbox-community/netbox#23533 ·
Maintainers usually reply within 1 day
-
app: scripts status: backlog type: documentation
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
netbox-community/netbox-scripts#68 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 91/100
marin-community/marin#10765 ·
Maintainers usually reply within 1 day