add deprecation workflow#977
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a GitHub Actions workflow intended to deprecate the @stellar/stellar-base package on npm, aligning the repo with the plan to direct users to @stellar/stellar-sdk.
Changes:
- Introduces a new Actions workflow to run
npm deprecateagainst@stellar/stellar-base. - Configures Node.js 20 and npm registry auth via
NPM_TOKEN.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| on: | ||
| pull_request: | ||
|
|
| - name: Deprecate package on npm | ||
| run: npm deprecate "@stellar/stellar-base" "This package is now rolled into @stellar/stellar-sdk. Please use @stellar/stellar-sdk to continue receiving updates and support." |
|
Size Change: 0 B Total Size: 3.54 MB ℹ️ View Unchanged
|
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 864d09766b
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
| name: npm deprecate | ||
|
|
||
| on: | ||
| pull_request: |
There was a problem hiding this comment.
Use a non-PR trigger for the registry mutation
When this workflow is present on the base branch, GitHub's pull_request event runs by default on opened/synchronize/reopened PR activity, and for same-repository PRs NPM_TOKEN is available; that means merely opening or pushing to a PR will run npm deprecate @stellar/stellar-base before anything is merged. npm's deprecation docs describe this no-version command form as deprecating the entire package, so this can mark the public package deprecated from review traffic rather than from an intentional release/manual job; use a release, protected-branch push, or workflow_dispatch trigger instead.
Useful? React with 👍 / 👎.
No description provided.