From 5e93ba5c98866ff633cced7ed9e6f4ea0d879dbd Mon Sep 17 00:00:00 2001 From: Arnaud Brousseau Date: Mon, 11 Nov 2024 13:38:48 -0600 Subject: [PATCH 1/2] Remove old references to toolchain and release process --- README.md | 28 ---------------------------- 1 file changed, 28 deletions(-) diff --git a/README.md b/README.md index c75cb596..97e0e378 100644 --- a/README.md +++ b/README.md @@ -129,32 +129,4 @@ make TARGET=generic make run ``` -#### Enter shell in toolchain environment -``` -make toolchain-shell -``` - -#### Update toolchain dependency pins -``` -make toolchain-update -``` - - -### Release Process - - 0. Determine the release semver version by consulting the [changelog](./CHANGELOG.MD). - 1. Create a branch for your release e.g. - `git checkout -b release/v1.0.0` - 2. Run `make dist` as described in ["Release" section](#release) - 3. Commit the new dist folder `git commit -m "Release v1.0.0" -- dist/` - 4. Push up your branch to github, and make a pull request. - 5. You may also create and push a signed `-rcX` git tag where the number after `rc` doesn't already exist. - `git tag -S v1.0.0-rc0 -m v1.0.0-rc0` - `git push origin v1.0.0-rc0` - 6. Wait for others to replicate your build, see ["Verify" section](#verify) - 7. Once the release has enough `git sig` signatures, make the final tag and merge the pull request. - `git tag -S v1.0.0 -m v1.0.0` - `git push origin v1.0.0` - - [gs]: https://codeberg.org/distrust/git-sig From 49714d6b4ba19049d246d4e80925914f32aed33e Mon Sep 17 00:00:00 2001 From: Arnaud Brousseau Date: Mon, 11 Nov 2024 13:40:27 -0600 Subject: [PATCH 2/2] Update instructions to submit a PR --- src/README.md | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) diff --git a/src/README.md b/src/README.md index 6fdc3c62..bec5b989 100644 --- a/src/README.md +++ b/src/README.md @@ -12,21 +12,16 @@ The Quorum Key itself can be used by QuorumOS and enclave apps to encrypt and au ### Submitting a PR -Before a PR can be merged it must: - -Be formatted +Before a PR can be merged you must run: ```bash -make lint +make lint # apply standardized code formatting +make test # run unit tests locally ``` -And pass all tests - -```bash -make test-all -``` +All tests must pass. -The PR will also need to pass the `build-linux-only-crates` github workflow. There are 3 crates excluded from the rust workspace: `qos_system`, `qos_aws`, and `init`. These crates are excluded because they only build on linux. If you are not working directly with these crates they generally only need to be updated if the dependencies for `qos_core` change. The linux only crates each have their own lockfile and that will need to be up to date for deterministic builds to work. To update the locks files you will need a linux build environment. Once in a linux build enviroment you can run `make build-linux-only`, which will update lock files if neccesary; any updated lock files should then be committed. +The PR will also need to pass the `build-linux-only` github workflow. There are 3 crates excluded from the Rust workspace: `qos_system`, `qos_aws`, and `init`. These crates are excluded because they only build on Linux. If you are not working directly with these crates they generally only need to be updated if the dependencies for `qos_core` change. The linux only crates each have their own lockfile and that will need to be up to date for deterministic builds to work. To update the locks files you will need a linux build environment. Once in a linux build environment you can run `make build-linux-only`, which will update lock files if necessary; any updated lock files should then be committed. ### View the docs