|
2 | 2 |
|
3 | 3 | Directions to set up your project are available in the [README](../README.md).
|
4 | 4 |
|
5 |
| -Before you make your changes, check to see if an [issue exists](https://github.com/dfinity/agent-js/issues). If there isn't one, you can [create one](https://github.com/dfinity/agent-js/issues/new/choose) to discuss your proposed changes. |
| 5 | +Before you make your changes, check to see if an [issue exists](https://github.com/dfinity/icp-js-core/issues). If there isn't one, you can [create one](https://github.com/dfinity/icp-js-core/issues/new/choose) to discuss your proposed changes. |
6 | 6 |
|
7 | 7 | ## Forking the repository
|
8 | 8 |
|
@@ -98,7 +98,7 @@ We utilize the [release-it](https://github.com/release-it/release-it) package to
|
98 | 98 |
|
99 | 99 | Start the process by initiating the GitHub Action Workflow `prepare-release.yml`. This can be done by:
|
100 | 100 |
|
101 |
| -- Navigating to the GitHub web UI and clicking "Run workflow" at https://github.com/smallstepman/agent-js/actions/workflows/prepare-release.yml, or |
| 101 | +- Navigating to the GitHub web UI and clicking "Run workflow" at https://github.com/dfinity/icp-js-core/actions/workflows/prepare-release.yml, or |
102 | 102 | - Running this command from your console:
|
103 | 103 | ```shell
|
104 | 104 | gh workflow run "prepare-release.yml" -f "semverBump=major"
|
@@ -249,7 +249,7 @@ Once the changes are merged, you can publish to NPM by running:
|
249 | 249 | - To do this, you will need publishing authorization under our NPM organization. Contact IT if you require access.
|
250 | 250 | - You can include the `--dry-run` flag to verify the version before actual publishing.
|
251 | 251 |
|
252 |
| -After publishing to NPM, go to https://github.com/dfinity/agent-js/releases/new, select "Draft a new release", enter the new tag version (in `v#.#.#` format), and click "Publish release". |
| 252 | +After publishing to NPM, go to https://github.com/dfinity/icp-js-core/releases/new, select "Draft a new release", enter the new tag version (in `v#.#.#` format), and click "Publish release". |
253 | 253 |
|
254 | 254 | </details>
|
255 | 255 |
|
@@ -283,14 +283,9 @@ Docs are built and published in the `publish-docs` step of the [`publish.yml`](.
|
283 | 283 |
|
284 | 284 | To deprecate a package, follow these steps
|
285 | 285 |
|
286 |
| -- Remove all contents except the package.json, license, and readme |
287 | 286 | - Add a note to the README saying `**Warning** this package is deprecated`
|
288 |
| -- Remove unnecessary content, dependencies, and metadata from the package.json |
289 |
| -- add a `"deprecation"` tag to the package.json with instructions you want users to follow in migrating |
290 |
| -- remove the package as a workspace from the root `package.json` |
291 |
| -- the next time that agent-js releases, manually publish a new version of newly deprecated packages by incrementing the patch version and running `pnpm publish:packages` |
292 |
| -
|
293 |
| -So far, the following packages were deprecated: |
294 |
| -
|
295 |
| -- @dfinity/ledger-identityhq (#665) |
296 |
| -- @dfinity/authentication (#665 & #661) |
| 287 | +- Increment the patch version of the package in its `package.json` file |
| 288 | +- Release the patched version of the package to NPM |
| 289 | +- Deprecate the package in NPM with `npm deprecate ...` |
| 290 | +- Remove the package from the root [`pnpm-workspace.yaml`](../pnpm-workspace.yaml) file |
| 291 | +- Optionally, remove all contents except the package.json, license, and readme. This can be done later, so that the source code stays available for reference for a while. |
0 commit comments