diff --git a/README.md b/README.md index 250c046..2009643 100644 --- a/README.md +++ b/README.md @@ -127,3 +127,30 @@ using a TLS endpoint (`https`). destination_path: destination.yaml configuration_path: configuration.yaml ``` + +### Progressive Rollouts + +The action can be used to progress a rollout ad-hoc, without modifying +configurations. + +To trigger a rollout progression, format your commit message with `progress rollout `. + +Example: + +```bash +git commit --allow-empty -m "progress rollout my-config" +``` + +The commit message must match this regular expression: + +``` +progress rollout (\S+)$ +``` + +Therefore the commit message can contain additional details, such as: + +```bash +git commit \ + --allow-empty \ + -m "Trigger rollout for dev: progress rollout dev-config" +``` diff --git a/cmd/action/main_test.go b/cmd/action/main_test.go index 830437e..d83394d 100644 --- a/cmd/action/main_test.go +++ b/cmd/action/main_test.go @@ -73,6 +73,12 @@ func Test_extractName(t *testing.T) { found: true, expected: "test_name", }, + { + name: "Readme example", + input: "Trigger rollout for dev: progress rollout dev-config", + found: true, + expected: "dev-config", + }, } for _, tc := range cases {