Skip to content

Commit

Permalink
Release workflow docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kacperzuk-neti committed Aug 1, 2024
1 parent 68abd6a commit 1040bbe
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ jobs:
with:
generate_release_notes: true
tag_name: ${{ steps.version.outputs.version }}
target_commitish:
target_commitish: "${{ github.sha }}"
files: |
linux_x86_build
mainnet-${{ steps.version.outputs.version }}.wasm
Expand Down
21 changes: 21 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Releasing new version

## Sanity checks:

1. Check `spec_version` value in [runtime's lib.rs](./substrate/bin/node/runtime/src/lib.rs). There are 2: one for mainnet and one for testnet. They should be the same and higher than the last release.
2. Check `version` in [runtime's Cargo.toml](./substrate/bin/node/runtime/Cargo.toml). Major version should match the `spec_version`.
3. Check `version` in [cli's Cargo.toml](./substrate/bin/node/cli/Cargo.toml). Major version should match the `spec_version`. This is the version that will be used as the name of the release and tag.

## Release

1. Go to the [Release new version](https://github.com/liberland/liberland_substrate/actions/workflows/release.yml) action in GitHub, select `Run workflow`, choose the branch (usually `develop` or `main`) and run it. This action will do the following:
* Run unit-tests
* Run `try-runtime` migration checks (which detects things like state inconsitencies or pallet/state version mismatches)
* Run fork test for both bastiat and mainnet and check if whole state is still parsable post-fork
* Build runtimes in a reproducible way
* Build new binary
* Create a new GitHub Release
* Build & publish new Docker Image
2. Wait for the `Release new version` action to finish.
3. Go to [GitHub Releases](https://github.com/liberland/liberland_substrate/releases). New release should be there, ready for deployment.
4. (Optional) Open a new PR that bumps versions for the next release. [Sample PR](https://github.com/liberland/liberland_substrate/pull/404/files).

0 comments on commit 1040bbe

Please sign in to comment.