Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(plugins): show a YAML example with path key #2089

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs(plugins): show a YAML example with path key #2089

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
18 changes: 17 additions & 1 deletion docs/usage/plugins.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,10 @@ Global plugin configuration can be defined at the root of the **semantic-release
["@semantic-release/github", {
"assets": ["dist/**"]
}],
"@semantic-release/git"
{
"path": "@semantic-release/git",
"message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
}
],
"preset": "angular"
}
Expand All @@ -97,3 +100,16 @@ Global plugin configuration can be defined at the root of the **semantic-release
With this configuration:
- All plugins will receive the `preset` option, which will be used by both `@semantic-release/commit-analyzer` and `@semantic-release/release-notes-generator` (and ignored by `@semantic-release/github` and `@semantic-release/git`)
- The `@semantic-release/github` plugin will receive the `assets` options (`@semantic-release/git` will not receive it and therefore will use it's default value for that option)
- `@semantic-release/git` uses the `path` option which is an alternative way of defining a plugin. This especially helps with the YAML representation:

```yaml
preset: angular
plugins:
- path: "@semantic-release/commit-analyzer"
- path: "@semantic-release/release-notes-generator"
- path: "@semantic-release/github"
assets:
- "dist/**"
- path: "@semantic-release/git"
message: "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
```