Skip to content

Commit 51dee17

Browse files
committed
feat: minor changes to README.md
1 parent 932b690 commit 51dee17

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

roles/github/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ The following variables can be used to make small adjustments to the composition
3636

3737
`github_output_directory`: control the location where the workflows shall be written to.
3838

39-
`github_environment_selector`: control the type of environment support the workflows should be generated with. Either `none` for no environment, `single` for fixed environment or `input` whereby the environment is controlled at `workflow_dispatch`
39+
`github_environment_selector`: control the type of environment support the workflows should be generated with. Either `single` for fixed environment or `input` whereby the environment is controlled at `workflow_dispatch`. No environment is the default by setting `github_environment_selector` to no value or `Null`.
4040

41-
`github_kayobe_environments`: list of environments the workflows should target. Only has effect when `github_environment_selector` is not `none`.
41+
`github_kayobe_environments`: list of environments the workflows should target. Only has effect when `github_environment_selector` is not `input` or `single`.
4242

4343
`github_runs_on`: control which runner can accept this workflow. See GitHub for more information on [runs-on](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on).
4444

@@ -50,11 +50,11 @@ The following variables can be used to make small adjustments to the composition
5050

5151
`github_kayobe_base_image`: select the base image used when building the kayobe docker image. Default is `quay.io/centos/centos:stream8` supports OpenStack Wallaby, Xena and Yoga. Zed and higher would require `quay.io/rockylinux/rockylinux:9`.
5252

53-
`github_kayobe_arguments`: a dictionary of arguments that can be used to override the default arguments found within `vars/main.yml`. For example if you wanted to change the value of `KAYOBE_ENVIRONMENT` from its default of `production` you can simply add `KAYOBE_ENVIRONMENT` to this dictionary and it will take precedence over the defaults.
53+
`github_kayobe_arguments`: a dictionary of arguments that can be used to override the default arguments found within `vars/main.yml`. For example if you wanted to change the value of `KAYOBE_AUTOMATION_PR_TITLE` from its default, you can do by simply adding `KAYOBE_AUTOMATION_PR_TITLE` to this dictionary and it will take precedence over the default.
5454

5555
`github_*_hook:` see section [Template Hooks](#template-hooks) for information about this variables
5656

57-
`github_buildx_enable`: In some deployments the build kayobe docker image workflow has had difficulties successfully pushing the image to container registries such as Pulp if buildx has been used. It situations where failure to push images is been experienced a user might wish to disable buildx. Buildx is enabled by default.
57+
`github_buildx_enable`: In some deployments the build kayobe docker image workflow has had difficulties successfully pushing the image to container registries such as Pulp if buildx has been used. It situations where failure to push images is been experienced a user might wish to disable buildx. Buildx is disabled by default.
5858

5959
`github_buildx_inline_config`: provide configuration parameters to buildx. Useful for connecting to insecure docker registry.
6060

@@ -143,7 +143,7 @@ The following example playbook will generate a series of `reference` workflows w
143143
- name: Write Kayobe Automation Workflows for GitHub
144144
hosts: localhost
145145
roles:
146-
- stackhpc.kayobe_automation_workflows.github
146+
- stackhpc.kayobe_workflows.github
147147
```
148148

149149
License

0 commit comments

Comments
 (0)