voicdgroupinc/YAML Update Action
Update the property of an existing YAML File
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| valueFile | YAML file which should be updated | no | — |
| propertyPath | Property Path - valid jsonPath expression | no | — |
| value | New property value | no | — |
| noCompatMode | Removes quotes from reserved words, like Y, N, yes, no, on, etc. | no | false |
| quotingType | QuotingType for YAML conversion, possible values are ' and ". Defaults to single quotes | no | ' |
| format | Supported file formats, possible values are YAML and JSON, will be guessed by file extension if not provided. Falls back to YAML | no | — |
| method | Configures the processing of none existing properties. Possible values: CreateOrUpdate, Update, Create | no | — |
| changes | Map of changes for a single or multiple files as JSON. Supports following formats: { "filepath": {"propertyPath": "value"}} or {"propertyPath": "value"}. If filepath is not provided it falls back to the path configured under valueFile. | no | — |
| branch | Branch to commit the change, will be created if not exist | no | "" |
| force | Branch to commit the change, will be created if not exist | no | false |
| masterBranchName | Branch name of your master | no | master |
| targetBranch | Target Branch for the created PullRequest | no | "" |
| githubAPI | GitHub BaseURL | no | https://api.github.com |
| createPR | Create a PullRequest to the configured target branch | no | false |
| commitChange | Commit the change "branch" with the given "message" | no | true |
| updateFile | Update the original File in your workflow | no | false |
| message | Commit message for the value update | no | "" |
| title | Title of the created pull request | no | "" |
| description | Description of the created pull request | no | "" |
| labels | Comma separated list of custom PR labels, e.g. "feature,yaml-updates" | no | yaml-updates |
| token | GitHub AuthToken for Authorization | no | ${{ github.token }} |
| repository | repository to update | no | ${{ github.repository }} |
| workDir | repository workspace location | no | . |
| commitUserName | Name used for the commit user | no | github-actions[bot] |
| commitUserEmail | Email address used for the commit user | no | 41898282+github-actions[bot]@users.noreply.github.com |
| reviewers | List of reviewers for the created Pull Request, if enabled | no | "" |
| teamReviewers | List of team reviewers for the created Pull Request, if enabled | no | "" |
| assignees | List of assignees for the created Pull Request, if enabled | no | "" |
Outputs
no outputs