diff --git a/README.md b/README.md index 9bb5ae9e3..d8ad18ad5 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,17 @@ If you are interested in contributing to this project, please read the [contribu ### Publishing +### For @dfinity/core + +@dfinity/core is published independently of the rest of the packages in this repo. To publish a new version of @dfinity/core, follow these steps; + +- Update the version in `packages/core/package.json` +- `npm install` +- `npm run build --workspace @dfinity/core` +- `npm publish --workspace @dfinity/core` + +### For the rest of the packages + To publish to NPM, create a branch and run the following commands; - `git clean -dfx`. Removes all non-tracked files and directories. @@ -57,7 +68,7 @@ Then, when you have merged the new versions and published to npm, open https://g ### Publishing Docs -Until we have an internal process and centrally owned canister, docs can be released manually for `@dfinity/agent` and `@dfinity/authentication`. +Until we have an internal process and centrally owned canister, docs can be released manually for all packages in this monorepo. - Start from a fresh clone (or `git clean -dfx .`) - `npm install` diff --git a/bin/version.ts b/bin/version.ts index 01e430aa9..c580e8442 100644 --- a/bin/version.ts +++ b/bin/version.ts @@ -49,7 +49,10 @@ const newVersion = (() => { console.log('New version will be: ' + newVersion); // Read workspaces from root package.json -const workspaces: string[] = rootPackage.workspaces?.packages; +const workspaces: string[] = rootPackage.workspaces?.packages.filter( + // omit @dfinity/core, whose version is not pinned + workspace => !workspace.includes('core'), +); // Identify packages in `/packages directory const packages = workspaces diff --git a/docs/generated/changelog.html b/docs/generated/changelog.html index 6d22722ae..74a27313c 100644 --- a/docs/generated/changelog.html +++ b/docs/generated/changelog.html @@ -12,6 +12,19 @@

Agent-JS Changelog

Version x.x.x