feat(release): prepare release notes

Signed-off-by: Paul Pietkiewicz <[email protected]>
enarx-archive · Apr 12, 2022 · 543d5b3 · 543d5b3
1 parent 0d365ba
commit 543d5b3
Show file tree

Hide file tree

Showing 2 changed files with 248 additions and 1 deletion.
diff --git a/docs/Contributing/Release.md b/docs/Contributing/Release.md
@@ -0,0 +1,247 @@
+# Release Process
+
+## Versioning
+- Breaking changes require a major version number increase, assuming a stable >0 major release 
+- Features require a minor number increase
+- Bugfixes require a patch number increase
+
+## Remotes
+> **NOTE:** Regarding git remotes:
+> * `upstream` points to core repository location
+> ```bash
+> export UPSTREAM="upstream"
+> ```
+> * `origin` points to the user's fork
+> ```bash
+> export FORK="origin"
+> ```
+
+
+## Prerequisites:
+- Prepare release notes
+- `cargo` credentials are cached
+- `git` credentials are available on host to allow pushing code
+- `gh` installed and configured
+- You are running the build process on a X86_64 host
+- Freeze all merges until release process complete
+
+
+## Weekly chores
+* [Update Rust toolchain](https://github.com/enarx/enarx/actions/workflows/rust-toolchain-update.yml)
+* [Update Cargo dependencies](https://github.com/enarx/enarx/actions/workflows/cargo-update.yml)
+
+
+### Update and release prerequiste crates
+> **NOTE:** The list of crates that need to be updated for a release can be seen by running this following command: 
+> ```bash
+> grep -R 'git+https' *.lock | sort | uniq
+> ```
+> This may be an optional step dependant on whether there are relevant changes in the prerequisite crates, including:
+> * [crt0stack](https://github.com/enarx/crt0stack)
+> * [flagset](https://github.com/enarx/flagset)
+> * [iocuddle](https://github.com/enarx/iocuddle)
+> * [lset](https://github.com/enarx/lset)
+> * [mmarinus](https://github.com/enarx/mmarinus)
+> * [mmledger](https://github.com/enarx/mmledger)
+> * [nbytes](https://github.com/enarx/nbytes)
+> * [noted](https://github.com/enarx/noted)
+> * [primordial](https://github.com/enarx/primordial)
+> * [rcrt1](https://github.com/enarx/rcrt1)
+> * [sallyport](https://github.com/enarx/sallyport)
+> * [sgx](https://github.com/enarx/sgx)
+> * [snp](https://github.com/enarx/snp)
+> * [vdso](https://github.com/enarx/vdso)
+> * [xsave](https://github.com/enarx/xsave)
+
+#### Assumptions:
+- All approved PRs are merged
+- Rust toolchain (if using snapshot) and `cargo update` has been run
+
+#### Steps:
+- Determine expected version by reviewing output of `git log`
+- Set new version
+  ```bash
+  export MAJOR=0
+  export MINOR=2
+  export PATCH=2
+  export NEW_VERSION="${MAJOR}.${MINOR}.${PATCH}"
+  ```
+- Set REPO variable, assuming GitHub repository matches directory name
+  ```bash
+  export REPO="$(basename ${PWD})"
+  ```
+- Get latest updates and checkout branch
+ > **NOTE:** The following assumes a new release
+  ```bash
+  git fetch ${UPSTREAM}
+  git checkout -b "b${MAJOR}.${MINOR}.z" ${UPSTREAM}/main
+  ```
+- Determine if crate builds and if it works
+  ```bash
+  cargo clean
+  cargo build --release
+  cargo test
+  ```
+- Update version in `Cargo.toml`
+  ```bash
+  sed -i 's/^version = .*/version = \"'${NEW_VERSION}'\"/' Cargo.toml
+  cargo update -p $(grep name Cargo.toml | cut -d'"' -f2)
+  ```
+- Run `cargo test` again
+  ```bash
+  cargo clean
+  cargo build --release
+  cargo test
+  ```
+- Check if cargo successfully builds with dry run
+  ```bash
+  cargo publish --allow-dirty -v --dry-run
+  ```
+- Commit change and push to repo
+  ```bash
+  git commit -asS -m "chore(release): Release v${NEW_VERSION}"
+  git push ${FORK} b${MAJOR}.${MINOR}.z
+  ```
+- Create a PR
+  ```bash
+  gh pr create -t "chore(release): Release v${NEW_VERSION}" \
+               -b "chore(release): Release v${NEW_VERSION}" \
+               -R enarx/${REPO}
+  ```
+- Confirm that changes passed on CI and merge PR
+- Checkout merged release branch
+  ```bash
+  git fetch ${UPSTREAM}
+  git checkout ${UPSTREAM}/main
+  ```
+- Tag the new release on upstream
+  ```bash
+  git tag --sign -m "chore(release): Release v${NEW_VERSION}" v${NEW_VERSION}
+  git push ${UPSTREAM} v${NEW_VERSION}
+  ```
+- Cargo publish
+  > **NOTE:** Assuming cargo credentials are cached
+  ```bash
+  cargo publish -v
+  ```
+
+### The Enarx release itself
+- Determine expected version by reviewing output of `git log`
+- Set new version
+  ```bash
+  export MAJOR=0
+  export MINOR=2
+  export PATCH=2
+  export NEW_VERSION="${MAJOR}.${MINOR}.${PATCH}"
+  ```
+- Get latest updates and checkout branch
+  ```bash
+  git fetch ${UPSTREAM}
+  git checkout -b "b${MAJOR}.${MINOR}.z" ${UPSTREAM}/main
+  ```
+- Bump version inside sub-crate `src/bin/{shim-kvm,shim-sgx,exec-wasmtime}/Cargo.toml` files
+  ```bash
+  for d in src/bin/*/ ; do ( cd "$d"
+    sed -i 's/^version = .*/version = \"'${NEW_VERSION}'\"/' Cargo.toml
+    cargo update -p $(basename ${d})
+  done
+  sed -i 's/^version = .*/version = \"'${NEW_VERSION}'\"/' Cargo.toml
+  cargo update -p $(grep name Cargo.toml | cut -d'"' -f2)
+  ```
+- _POTENTIALLY OPTIONAL STEP: If there are any changes in the prerequisite crates (e.g. `xsave`, `sallyport`, etc) then it will be required to manually update the crates now_
+  ```bash
+  export UPDATED_PREREQUISTES=(xsave sallyport)
+  for d in src/bin/*/ ; do ( cd "$d"
+    for p in ${UPDATED_PREREQUISTES[@]]}; do
+      cargo update -p "${p}"
+    done
+  done
+  for p in ${UPDATED_PREREQUISTES[@]]}; do cargo update -p ${p}; done
+  ```
+- Run unit tests
+  ```bash
+  cargo clean
+  cargo build --release
+  cargo test
+  ```
+- Check cargo manifest
+  ```bash
+  cargo package --allow-dirty -l
+  ```
+- Check if cargo successfully builds with dry run
+  ```bash
+  cd src/bin/shim-kvm; cargo publish --allow-dirty --dry-run -v --target x86_64-unknown-none; cd ..
+  cd shim-sgx; cargo publish --allow-dirty --dry-run -v --target x86_64-unknown-none; cd ..
+  cd exec-wasmtime; cargo publish --allow-dirty --dry-run -v ; cd ../..
+  ```
+- Commit change and push to repo
+  ```bash
+  git commit -asS -m "chore(release): Release v${NEW_VERSION}"
+  git push ${FORK} "release/${NEW_VERSION}"
+  ```
+- Packaging binary dependency crates
+  > **NOTE:** Assuming cargo credentials are cached
+  ```bash
+  cd src/bin/shim-kvm; cargo publish -v --target x86_64-unknown-none; cd ..
+  cd shim-sgx; cargo publish -v --target x86_64-unknown-none; cd ..
+  cd exec-wasmtime; cargo publish -v ; cd ../..
+  ```
+- Update enarx dependencies
+  ```bash
+  export UPDATED_BINDEPS=(enarx-exec-wasmtime enarx-shim-kvm enarx-shim-sgx)
+  for p in ${UPDATED_PREREQUISTES[@]]}; do
+      cargo update -p "${p}"
+  done
+  ```
+- Run unit tests
+  ```bash
+  cargo clean
+  cargo build --release
+  cargo test
+  ```
+- Cargo dry-run publish
+  ```bash
+  cargo publish --allow-dirty --dry-run -v
+  ```
+- Commit change and push to repo
+  ```bash
+  git commit -asS --amend 
+  git push --force ${FORK} "release/${NEW_VERSION}"
+  ```
+- Create a PR
+  ```bash
+  gh pr create -t "chore(release): Release v${NEW_VERSION}" \
+               -b "chore(release): Release v${NEW_VERSION}" \
+               -R enarx/${REPO}
+  ```
+- Confirm that changes passed on CI and merge PR
+- Checkout merged release branch
+  ```bash
+  git fetch ${UPSTREAM}
+  git checkout ${UPSTREAM}/main
+  ```
+- Tag the new release on upstream
+  ```bash
+  git tag --sign -m "chore(release): Release v${NEW_VERSION}" v${NEW_VERSION}
+  git push ${UPSTREAM} v${NEW_VERSION}
+  ```
+- Create a release PR
+  ```bash
+  gh pr create -t "Release v${NEW_VERSION}" \
+               -b ""
+               -B main \
+               -R enarx/enarx
+  ```
+- Merge release PR
+- Cargo publish
+  ```bash
+  cargo publish -v
+  ```
+- Create draft GitHub release
+  ```bash
+  gh release create -d --generate-notes "v${NEW_VERSION}"
+  ```
+- Update release notes on draft GitHub release
+- Publish GitHub release
+- Send notification to RocketChat #annoucements & #general channels
+- Assign issue to post release to social media channels
diff --git a/sidebars.js b/sidebars.js
@@ -41,7 +41,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',