Skip to content

Commit

Permalink
docs(readme): add semantic-release-hex plugin doc
Browse files Browse the repository at this point in the history
  • Loading branch information
sheerlox committed Nov 17, 2023
1 parent 7a950d9 commit 77e083e
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,47 @@
](https://securityscorecards.dev/viewer/?uri=github.com/talent-ideal/semantic-release-hex)
[![Discord](https://img.shields.io/discord/1158414767770308648?logo=discord)](https://discord.gg/cRB8XRFKzH)

> **Warning**
> Publishing to `hex` has not yet been implemented, so this package only bumps the version in `mix.exs` for now.
| Step | Description |
| ------------------ | --------------------------------------------------------------------------- |
| `verifyConditions` | Verify the presence of the `mix.exs` file and that the version is parsable. |
| `prepare` | Update the version in `mix.exs`. |
| _`addChannel`_ | _to be implemented (PRs welcome)_ |
| _`publish`_ | _to be implemented (PRs welcome)_ |

## Installation

```shell
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)

### Example

```json
{
"plugins": [
"@semantic-release/commit-analyzer",
"@semantic-release/release-notes-generator",
"@semantic-release/changelog",
[
"@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"
]
}
```

## Community

Join the [Discord server](https://discord.gg/cRB8XRFKzH)! Here you can discuss issues and get help in a more casual forum than GitHub.
Expand Down

0 comments on commit 77e083e

Please sign in to comment.