Prepare release notes

Signed-off-by: Paul Pietkiewicz <[email protected]>

Author: platten

docs/Contributing/Release.md

@@ -0,0 +1,114 @@
+# How to Release
+
+## Prerequisites:
+- Prepare release notes
+- Update all `rust` channels (nightly, beta & stable)
+
+## Update and release prerequiste crates
+
+### Prerequisites
+This includes `xsave`, `sallyport`, etc crates:
+- Ensure all approved PRs are merged
+- Get latest updates
+  ```bash
+  git fetch --all
+  git rebase upstream/main
+  ```
+- Determine if crate builds and if it works
+  ```bash
+  cargo clean
+  cargo <+nightly | +beta> test
+  ```
+- Update dependencies
+  ```bash
+  cargo update
+  ```
+- Determine version bump by reviewing output of `git log`
+- Update and bump version in `Cargo.toml`
+- Run `cargo test` again
+- Commit change and push to repo
+  ```bash
+  git commit -asm 'Release vX.X.X'
+  git push origin
+  ```
+- Confirm that changes passed on CI
+- Create a git tag
+  ```bash
+  git tag vX.X.X
+  git push origin vX.X.X
+  ```
+- Cargo publish
+  ```bash
+  cargo +beta publish
+  ```
+
+### `enarx` Pre-release
+- Ensure all PRs are merged and that all CI tests passes
+- Check to see `Cargo.toml` is refering to the latest updated prerequisite crates
+- Run cargo-update on all individual sub-crates in updated packages are referenced
+   ```bash
+   cd internal/
+   for d in ./*/ ; do (cd "$d" && cargo update); done
+   cd ..
+   ```
+- Git commit sub-crate update
+  ```bash
+   git commit -asm 'Updated Enarx sub-crate dependencies'
+   ```
+- Run cargo update on `enarx`
+  ```bash
+  cargo update
+  ```
+- Git commit sub-crate update
+  ```bash
+   git commit -asm 'Updated Enarx dependencies'
+   ```
+- Run build and tests
+  ```bash
+  cargo clean
+  cargo +nightly build
+  cargo +nightly tests
+  ```
+
+## `enarx` Release
+- Bump version inside sub-crate `internal/{shim-sev,shim-sgx,wasmdr}/Cargo.toml` files
+  ```bash
+   cd internal/
+   for d in ./*/ ; do (cd "$d" && sed -i '' 's/^version = "<OLD_VERSION>"/version = "<NEW_VERSION>"/' Cargo.toml); done
+   ```
+- Rename `Cargo.toml` TOML files to work around the fact that `cargo` does not allow publishing subcrates
+  ```bash
+   for i in internal/*/Cargo.toml; do git mv $i ${i%.toml}.tml; done
+   ```
+- Check cargo manifest with `cargo package --allow-dirty`
+- Run unittests `cargo test`
+- Commit change and push to repo
+  ```bash
+  git commit -asm 'Release vX.X.X'
+  git push origin`
+  ```
+- Create and push `git` tag
+  ```bash
+  git tag v.X.X.X
+  ```
+- Create and push `git` tag
+  ```bash
+  git tag v.X.X.X
+  git push origin HEAD
+  git push --tags origin HEAD
+  ```
+- Package and publish Enarx crate
+  ```bash
+  cargo publish -v
+  ```
+- Restore Cargo.tml files to Cargo.toml fils
+  ```bash
+  for i in internal/*/Cargo.tml; do git mv $i ${i%.tml}.toml; done
+  git commit -asm 'chore: put back Cargo.toml'
+  git push origin HEAD
+  ```
+- Create draft GitHub release
+  ```bash
+  gh release create -d --generate-notes vX.X.X
+  ```
+- Update suppliment GitHub release notes and complete release

sidebars.js

@@ -31,7 +31,7 @@ const sidebars = {
     {
       type: 'category',
       label: 'Contributing Guide',
-      items: ['Contributing/Introduction','Contributing/Onboarding','Contributing/Code','Contributing/Coding-Style','Contributing/Git-hook','Contributing/PRs','Contributing/Issues','Contributing/RFCs','Contributing/Docs','Contributing/Outreach','Contributing/Lab'],
+      items: ['Contributing/Introduction','Contributing/Onboarding','Contributing/Code','Contributing/Coding-Style','Contributing/Git-hook','Contributing/PRs','Contributing/Issues','Contributing/RFCs','Contributing/Docs','Contributing/Outreach','Contributing/Lab', 'Contributing/Release'],
     },
     {
       type: 'category',