@wireapp/core-crypto 1.0.1 → 1.1.0

package/README.md

@@ -30,6 +30,12 @@ See [ARCHITECTURE.md](docs/ARCHITECTURE.md)
 - rust: [https://www.rust-lang.org/tools/install](https://www.rust-lang.org/tools/install)
 - cargo-make: [https://sagiegurari.github.io/cargo-make/](https://sagiegurari.github.io/cargo-make/)
 
+If you're using macOS, you'll also need to install GNU sed:
+```ignore
+brew install gnu-sed
+```
+and add an alias to your shell configuration file: `alias sed=gsed` (e.g. to `~/.zshenv` if you're using zsh).
+
 ### Android
 
 Install Android SDK and Build-Tools for API level 30+
@@ -131,6 +137,24 @@ cargo install cargo-nextest
 cargo nextest run
 ```
 
+#### Run core crypto tests on WASM target
+
+If you haven't already, install the target and wasm-pack:
+
+```ignore
+rustup target add wasm32-unknown-unknown
+cargo install wasm-pack
+```
+
+If you want to test for chrome, [get chromedriver](https://getwebdriver.com/chromedriver) or the webdriver for the
+browser you want to test for, respectively.
+
+Then, to run tests for a crate in the workspace do
+
+```ignore
+wasm-pack test --headless --chrome ./<crate-folder-to-test>
+```
+
 #### Addendum: testing all ciphersuites
 
 > [!warning]
@@ -180,9 +204,14 @@ The reports generated by criterion will be located in `target/criterion`.
 
 ## Git workflow
 
-* The `main` branch is only updated when making a release and should always point to the latest release.
-* The `develop` branch is used as the everyday development branch.
-* No merge commits. Always rebase on top of `develop`.
+* The `main` branch is used as the everyday development branch.
+* No merge commits. Always rebase on top of `main`.
+* Release branches are named `release/<series>`, e.g. `release/1.x`, `release/2.x`.
+* Release branches contain fixes relevant to their specific release series and are never merged to `main`.
+* Release branches always branch off their first major release tag. For example,
+  the output of `git merge-base main release/2.x` must be a commit pointed to by tag `v2.0.0`.
+* Release branches are created lazily, that is, only when the first fix needs to be applied and released
+  for a specific release series.
 * Use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) -- those are picked up by the changelog generator.
 * If there is a JIRA ticket related to the change, you should mention it in either the PR title or the commit(s),
   with the following format: `[TICKET_ID]`.
@@ -199,27 +228,35 @@ The versioning scheme used is [SemVer AKA Semantic Versioning](https://semver.or
 
 ### Making a new release
 
-1. Make a release branch started from `develop` (`git checkout -b release/X.Y.Z`)
-1. Run `cargo xtask release bump [major|minor|patch|rc|pre] --dry-run`, check if it's the expected result
-1. If all seems fine, re-run the previous command without the `--dry-run` argument.
-   This will bump the versions of:
+1. Make a branch based on `main` to prepare for release (`git checkout -b prepare-release/X.Y.Z`)
+1. Run `sh scripts/update-versions.sh X.Y.Z` to update the versions of
     - all workspace member crates
     - `package.json`
     - `crypto-ffi/bindings/gradle.properties`
-1. Edit `CHANGELOG.tpl` with the contents of the release.
-    - Copy the git-conventional block from the previous release to your new release, modify the version tag
-    - Remove the `unreleased=true` from the previous release
-    - Try to write some human concise documentation so that client teams understand the changes at a glance
-1. Run `cargo xtask documentation changelog` to generate the corresponding `CHANGELOG.md`
-1. Make sure the changes look reasonable and complete; you can use
-   [this commit](https://github.com/wireapp/core-crypto/commit/e680590ba6969ca2dc47aa38c7f220ea8974b369)
-   as a reference.
-1. Push your `release/X.Y.Z` branch and create a PR for it
-1. Get it reviewed, then merge it into `develop` and remove the release branch from the remote.
-1. Now, pull your local develop `git checkout develop && git pull`
-1. Update the `main` branch: `git checkout main && git pull && git merge --ff-only develop`
+   Make sure the result of the script run is correct.
+1. Generate the relevant changelog section:
+   ```bash
+   git cliff --bump --unreleased
+   ```
+   and add it to the top of `CHANGELOG.md`.
+   Make sure the version number generated by `git cliff` matches the release version.
+1. If there are any release highlights, add them as the first subsection below release title:
+   ```markdown
+   ## v1.0.2 - 2024-08-16
+
+   ### Highlights
+
+   - foo
+   - bar
+   - baz
+   ```
+1. Make sure the changes look reasonable and complete; you can use the previous release as a reference
+1. Push your `prepare-release/X.Y.Z` branch and create a PR for it
+1. Get it reviewed, then merge it into `main` and remove the `prepare-release/X.Y.Z` branch from the remote
+1. Now, pull your local `main`: `git checkout main && git pull`
 1. Create the release tag: `git tag -s vX.Y.Z`
-1. Push the branch and the new tag: `git push origin main && git push --tags`
+1. Push the new tag: `git push origin tag vX.Y.Z`
+1. Create a new release on github, copying the relevant section from `CHANGELOG.md`
 1. Voilà!
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wireapp/core-crypto",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "CoreCrypto bindings for the Web",
   "type": "module",
   "module": "platforms/web/corecrypto.js",
@@ -43,4 +43,4 @@
     "ts-loader": "^9.5.1",
     "typescript": "^5.3.3"
   }
-}
+}