Skip to content

Commit 2bfc8a6

Browse files
Merge pull request #489
2 parents a4b08d9 + 49714d6 commit 2bfc8a6

File tree

2 files changed

+5
-38
lines changed

2 files changed

+5
-38
lines changed

README.md

-28
Original file line numberDiff line numberDiff line change
@@ -129,32 +129,4 @@ make TARGET=generic
129129
make run
130130
```
131131

132-
#### Enter shell in toolchain environment
133-
```
134-
make toolchain-shell
135-
```
136-
137-
#### Update toolchain dependency pins
138-
```
139-
make toolchain-update
140-
```
141-
142-
143-
### Release Process
144-
145-
0. Determine the release semver version by consulting the [changelog](./CHANGELOG.MD).
146-
1. Create a branch for your release e.g.
147-
`git checkout -b release/v1.0.0`
148-
2. Run `make dist` as described in ["Release" section](#release)
149-
3. Commit the new dist folder `git commit -m "Release v1.0.0" -- dist/`
150-
4. Push up your branch to github, and make a pull request.
151-
5. You may also create and push a signed `-rcX` git tag where the number after `rc` doesn't already exist.
152-
`git tag -S v1.0.0-rc0 -m v1.0.0-rc0`
153-
`git push origin v1.0.0-rc0`
154-
6. Wait for others to replicate your build, see ["Verify" section](#verify)
155-
7. Once the release has enough `git sig` signatures, make the final tag and merge the pull request.
156-
`git tag -S v1.0.0 -m v1.0.0`
157-
`git push origin v1.0.0`
158-
159-
160132
[gs]: https://codeberg.org/distrust/git-sig

src/README.md

+5-10
Original file line numberDiff line numberDiff line change
@@ -12,21 +12,16 @@ The Quorum Key itself can be used by QuorumOS and enclave apps to encrypt and au
1212

1313
### Submitting a PR
1414

15-
Before a PR can be merged it must:
16-
17-
Be formatted
15+
Before a PR can be merged you must run:
1816

1917
```bash
20-
make lint
18+
make lint # apply standardized code formatting
19+
make test # run unit tests locally
2120
```
2221

23-
And pass all tests
24-
25-
```bash
26-
make test-all
27-
```
22+
All tests must pass.
2823

29-
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.
24+
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.
3025

3126
### View the docs
3227

0 commit comments

Comments
 (0)