diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5778552..000cc35 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -41,11 +41,12 @@ cargo test --workspace ## Release a new version of the extension Once your changes are on the `main` branch and you wish to release a new version of the extension, the process consists of the following steps: -1. Create a new GitHub Release with the extension's binaries. The whole process is automated using GitHub Actions. Go to https://github.com/dfinity/dfx-extensions/actions/workflows/release-with-github.yml and click `Run workflow`, then follow the instructions in the pop-up menu. Alternatively, you can trigger this workflow from your shell by navigating to the repository directory and running: +1. Create a new GitHub Release with the extension's binaries. The whole process is automated using GitHub Actions. Go to https://github.com/dfinity/dfx-extensions/actions/workflows/release-with-github.yml and click `Run workflow`, then follow the instructions in the pop-up menu. Alternatively, you can trigger this workflow from your shell by navigating to the repository directory and running (in this example, we're releasing `nns` extension, version `1.2.3`): ```console gh workflow run "release-with-github.yml" -f whichCrate=nns -f semverVersion=1.2.3 ``` -Once the workflow finishes running, it will open a PR that you need to review and merge. + Once the workflow finishes running, it will open a PR that you need to review and merge. + 2. Copy the relevant section from the extension's `CHANGELOG.md` to the description in GitHub Releases. ## Styleguides