diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml deleted file mode 100644 index f7451aceb..000000000 --- a/.github/workflows/release.yml +++ /dev/null @@ -1,39 +0,0 @@ -name: NPM publish CD workflow - -on: - release: - types: [published] - -jobs: - build: - environment: Release - runs-on: ${{ matrix.os }} - strategy: - fail-fast: true - matrix: - os: [ubuntu-18.04] - node: - - 14 - - steps: - - uses: actions/checkout@v2 - - name: Use Node.js ${{ matrix.node }} - uses: actions/setup-node@v1 - with: - node-version: ${{ matrix.node }} - - run: npm install -g npm - - run: npm install - # set up git since we will later push to the repo - - run: git config --global user.name "GitHub CD bot" - - run: git config --global user.email "npm@dfinity.org" - # build the project - - run: npm run build --workspaces - # run tests just in case - - run: npm test - # publish to NPM - - run: npm config set '//registry.npmjs.org/:_authToken' "$NPM_TOKEN" - env: - # Use a token to publish to NPM. See below for how to set it up - NPM_TOKEN: ${{ secrets.NPM_TOKEN }} - - run: npm whoami - - run: npm publish --workspaces --access public diff --git a/README.md b/README.md index dec1cc336..9dd1a9502 100644 --- a/README.md +++ b/README.md @@ -39,12 +39,21 @@ To publish to NPM, create a branch and run the following commands; - `npm install`. Makes sure everything is installed and up to date locally; - `npm run build --workspaces`. Builds all the applications and packages. - `npm run version [patch|major|minor|version]`. Update the version in each of the packages. +- Manually update the version in the root package.json file. +- `npm install`. Updates the versions of the packages in the package-lock.json file. - `git checkout -b release/v<#.#.#>`. Check out release branch - `git add .`. Check out release branch - `git commit -m 'chore: release v<#.#.#>'`. Commit changes - Open a pull request from your fork of the repository -Then, when you have merged the new versions, open https://github.com/dfinity/agent-js/releases/new, click the "Draft a new release" button, enter the new tag version in form `v#.#.#`, and click "Publish release". +Once the change is merged, you can publish to NPM. To publish to NPM, run the following commands; + +- `npm run build --workspaces`. This is just for safety +- `npm publish --workspaces`. Publishes the packages to NPM. + - You will need to have authorization to publish the npm packages in our NPM organization. Reach out to IT if you neeed access. + - You can add the `--dry-run` flag to see what would have been published and make sure that all the versions and packages look correct. + +Then, when you have merged the new versions and published to npm, open https://github.com/dfinity/agent-js/releases/new, click the "Draft a new release" button, enter the new tag version in form `v#.#.#`, and click "Publish release". ### Publishing Docs diff --git a/docs/generated/changelog.html b/docs/generated/changelog.html index b13b68995..c88fd7a5c 100644 --- a/docs/generated/changelog.html +++ b/docs/generated/changelog.html @@ -10,6 +10,20 @@