Update staking-miner positional args (#102)

paritytech · Jun 27, 2022 · 25cb3bb · 25cb3bb
1 parent 9d05a0f
commit 25cb3bb
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 2 deletions.
diff --git a/charts/staking-miner/Chart.yaml b/charts/staking-miner/Chart.yaml
@@ -2,7 +2,7 @@ apiVersion: v2
 name: staking-miner
 description: A Helm chart to deploy staking miner (https://github.com/paritytech/staking-miner)
 type: application
-version: 1.0.0
+version: 1.1.0
 maintainers:
   - name: Parity
     url: https://github.com/paritytech/helm-charts

diff --git a/charts/staking-miner/README.md b/charts/staking-miner/README.md
@@ -42,6 +42,21 @@ The command removes all the Kubernetes components associated with the chart and
 
 > **NOTE**: The Helm chart uses [readme-generator](https://github.com/bitnami-labs/readme-generator-for-helm) to generate [Parameters](#parameters) section. Make sure to update the parameters with that tool instead of manually editing it.
 
+## Upgrading
+### ⚠️ 1.1.0 (breaking change)
+Chart version 1.1.0 has breaking changes. staking-miner CLI [has changed](https://github.com/paritytech/polkadot/pull/5577) the order of positional arguments.
+
+Before:
+```
+staking-miner --seed-or-path <foo> monitor|dry-run
+```
+
+Now:
+```
+staking-miner monitor|dry-run --seed-or-path <foo>
+```
+
+If you use a customized value for `args` make sure to update it accordingly. If you use `args` as is you don't have to do anything.
 ## Parameters
 
 ### Global parameters

diff --git a/charts/staking-miner/values.yaml b/charts/staking-miner/values.yaml
@@ -162,7 +162,7 @@ command: ["/bin/sh"]
 args:
 - -c
 - |
-  staking-miner --seed-or-path /config/seed --uri $(cat /config/uri) monitor seq-phragmen
+  staking-miner monitor --seed-or-path /config/seed --uri $(cat /config/uri) seq-phragmen
 ## @param hostAliases staking-miner pods host aliases
 ## https://kubernetes.io/docs/concepts/services-networking/add-entries-to-pod-etc-hosts-with-host-aliases/
 ##