semantic-release plugin to edit yaml files
npm install semantic-release-yamlsemantic-release plugin to change yaml files.
| Step | Description |
| --------- | ----------------------------------- |
| prepare | edit yaml during prepare the phase. |
``bash`
$ npm install semantic-release-yaml -D
The plugin can be configured in the semantic-release configuration file:
`json`
{
// We specify the branches, on which semantic-release should run.
// This will be used in a later step, when we use the current
// branch name as variables in the configuration.
"branches": ["main", "next"],
"plugins": [
"@semantic-release/commit-analyzer",
"@semantic-release/npm",
[
"semantic-release-yaml",
{
// A list of files to edit.
"commands": [
{
// The current working directory is the root of the project.
"cwd": "./",
// The file to edit
"file": "./Chart.yaml",
// The field in the file to edit.
"selector": "version",
// The value to set the field to.
"value": "${nextRelease.version}"
},
{
"cwd": "./",
// A dynamic file name.
"file": "./${branch.name}.yaml",
"selector": "name",
"value": "${nextRelease.version}"
}
]
}
],
[
"@semantic-release/git",
{
// Make sure Chart.yaml is pushed to the remote repository
"assets": [
"package.json",
"Chart.yaml",
// Also include main.yaml and next.yaml. These are the possible
// outcomes of the second command: the dynamic file name.
"./main.yaml",
"./next.yaml"
]
}
]
]
}
- Lodash template: https://lodash.com/docs/4.17.15#template
Each variable (cwd, file, selector, value) in a command is evaluated via lodash's template function.
`json`
{
...
"value": "${nextRelease.version}"
}
You can use all variables available in the semantic-release context
- Lodash set: https://lodash.com/docs/4.17.15#set
Next to this; selector is used by lodash's set function to set the value of the field.
This means you can write the following command:
`json`
{
...
"selector": "meta.version",
"value": "${nextRelease.version}"
}
which could result in the following:
`yaml``
version:
value: "1.0.0"
Yaml comments will be preserved.