From f60c678af836933745df6dd99bb2ffadf2d2e4e8 Mon Sep 17 00:00:00 2001 From: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> Date: Thu, 30 Mar 2023 15:38:42 +0100 Subject: [PATCH] Apply suggestions from code review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Damir Jelić --- .github/workflows/release_crypto_js.yml | 2 +- bindings/matrix-sdk-crypto-js/RELEASING.md | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/workflows/release_crypto_js.yml b/.github/workflows/release_crypto_js.yml index e6ca6c1a3..25eed08c6 100644 --- a/.github/workflows/release_crypto_js.yml +++ b/.github/workflows/release_crypto_js.yml @@ -2,7 +2,7 @@ # # It is triggered when a new tag appears that matches # `matrix-sdk-crypto-js-[0-9]+.*`. This workflow builds the package -# for the binding, run its tests to ensure everything is still +# for the bindings, runs its tests to ensure everything is still # correct, and publishes the package on NPM and on a newly created # Github release. diff --git a/bindings/matrix-sdk-crypto-js/RELEASING.md b/bindings/matrix-sdk-crypto-js/RELEASING.md index 840ce04fd..c6af870c3 100644 --- a/bindings/matrix-sdk-crypto-js/RELEASING.md +++ b/bindings/matrix-sdk-crypto-js/RELEASING.md @@ -1,14 +1,14 @@ Steps for releasing `matrix-sdk-crypto-js` ========================================== -1. Create a new branch, named `release-matrix-sdk-crypto-js-` +1. Create a new branch, named `release-matrix-sdk-crypto-js-`. 2. Update `CHANGELOG.md`, if necessary. 3. Run `yarn version` to bump the version number and create a tag. 4. Push the branch, but not yet the tag. 5. Create a PR to approve the changes. 6. Once approved: 1. Update the git tag to the new head of the branch, if necessary. - 2. push the git tag; doing so triggers the github actions workflow which - builds and publishes to npm, and creates a draft GH release - 3. merge the PR -7. Update the release on github and publish + 2. Push the git tag; doing so triggers the github actions workflow which + builds and publishes to npm, and creates a draft GH release. + 3. Merge the PR. +7. Update the release on github and publish.