Skip to content

Commit

Permalink
fix: renamed .github/README.md to ./github/workflows_documentation.md (
Browse files Browse the repository at this point in the history
…#845)

Signed-off-by: Logan Nguyen <[email protected]>
  • Loading branch information
quiet-node authored Jul 12, 2024
1 parent 231779b commit 14a7e97
Showing 1 changed file with 26 additions and 24 deletions.
50 changes: 26 additions & 24 deletions .github/README.md → .github/workflows_documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ When there is a new version released, no matter if it is network-node, mirror-no
Another concern with switching the network node's versions is "the migration" that is running under the hood. It occurs every time a node has been started and detects if there is data for migration. The migration testing workflow offers this type of testing where we can choose versions for pre/post image tags.

Available workflow inputs are:

- **initialNetworkNodeTag** - Specify the initial Network Node image tag
- **initialMirrorNodeTag** - Specify the initial Mirror Node image tag
- **initialRelayTag** - Specify the initial Relay image tag
Expand All @@ -21,32 +22,33 @@ Available workflow inputs are:
- **postMigrationTestTags** - Specify the post-migration test tags. Default: @post-migration. It could be every tag we want (e.g. **@OZERC20**)

Examples:

- if we want to test possible state corruption between mono and mod versions, we could use a setup like this:
- initialNetworkNodeTag: 0.48.1 # last tag for mono module
- initialMirrorNodeTag: 0.103.0
- initialRelayTag: 0.47.0
- targetNetworkNodeTag: 0.49.7 # first stable tag for modular module
- targetMirrorNodeTag: 0.103.0
- targetRelayTag: 0.47.0
- preMigrationTestTags: @pre-migration
- postMigrationTestTags: @post-migration
- initialNetworkNodeTag: 0.48.1 # last tag for mono module
- initialMirrorNodeTag: 0.103.0
- initialRelayTag: 0.47.0
- targetNetworkNodeTag: 0.49.7 # first stable tag for modular module
- targetMirrorNodeTag: 0.103.0
- targetRelayTag: 0.47.0
- preMigrationTestTags: @pre-migration
- postMigrationTestTags: @post-migration
- if we want to check for regressions on @OZERC20 suite after the relay's version update, we could use a setup like this:
- initialNetworkNodeTag: 0.49.7
- initialMirrorNodeTag: 0.104.0
- initialRelayTag: 0.47.0
- targetNetworkNodeTag: 0.49.7
- targetMirrorNodeTag: 0.104.0
- targetRelayTag: 0.48.0
- preMigrationTestTags: @OZERC20
- postMigrationTestTags: @OZERC20
- initialNetworkNodeTag: 0.49.7
- initialMirrorNodeTag: 0.104.0
- initialRelayTag: 0.47.0
- targetNetworkNodeTag: 0.49.7
- targetMirrorNodeTag: 0.104.0
- targetRelayTag: 0.48.0
- preMigrationTestTags: @OZERC20
- postMigrationTestTags: @OZERC20
- if we want to simulate the mirror node's version update, we could use a setup like this:
- initialNetworkNodeTag: 0.49.7
- initialMirrorNodeTag: 0.103.0
- initialRelayTag: 0.47.0
- targetNetworkNodeTag: 0.49.7
- targetMirrorNodeTag: 0.104.0
- targetRelayTag: 0.47.0
- preMigrationTestTags: @pre-migration
- postMigrationTestTags: @post-migration
- initialNetworkNodeTag: 0.49.7
- initialMirrorNodeTag: 0.103.0
- initialRelayTag: 0.47.0
- targetNetworkNodeTag: 0.49.7
- targetMirrorNodeTag: 0.104.0
- targetRelayTag: 0.47.0
- preMigrationTestTags: @pre-migration
- postMigrationTestTags: @post-migration

The testing matrix offers pretty big coverage as we can see. All options and combinations rely on us, and what's our end goal.

0 comments on commit 14a7e97

Please sign in to comment.