Skip to content

Commit

Permalink
docs(readme): add plugin position warning
Browse files Browse the repository at this point in the history
  • Loading branch information
sheerlox committed Nov 18, 2023
1 parent cb571ce commit ba52d5e
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,10 @@ npm install semantic-release-hex -D

## Usage

Add the plugin to the [**semantic-release** configuration file](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#configuration). (see example below)
Add the plugin to the [**semantic-release** configuration file](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#configuration) (see example below).

> **Warning**
> Make sure you put the `semantic-release-hex` plugin above `@semantic-release/git` and `@semantic-release/github`, or the updated `mix.exs` file won't be included in the commit/tag/release.
### Example

Expand All @@ -38,15 +41,15 @@ Add the plugin to the [**semantic-release** configuration file](https://github.c
"@semantic-release/commit-analyzer",
"@semantic-release/release-notes-generator",
"@semantic-release/changelog",
"semantic-release-hex",
[
"@semantic-release/git",
{
"assets": ["CHANGELOG.md", "mix.exs"],
"message": "chore(release): v${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
}
],
"@semantic-release/github",
"semantic-release-hex"
"@semantic-release/github"
]
}
```
Expand Down

0 comments on commit ba52d5e

Please sign in to comment.