Skip to content

Commit

Permalink
fix: add readme ToC
Browse files Browse the repository at this point in the history
  • Loading branch information
rdaniels6813 committed Nov 4, 2020
1 parent 618febd commit 85aead5
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,32 @@
# semantic-release-alpine
Alpine docker image for using semantic release in CI jobs.
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->


## Usage
- [Usage](#usage)
- [Basic Use](#basic-use)
- [Additional Plugins](#additional-plugins)
- [Subsequent steps dependent on a release](#subsequent-steps-dependent-on-a-release)

### Basic Use:
<!-- END doctoc generated TOC please keep comment here to allow auto update -->


## Basic Use
```yaml
- uses: rdaniels6813/semantic-release-alpine@master
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
```
### Additional Plugins
## Additional Plugins
Include additional semantic-release plugins separated by a space
```yaml
- uses: rdaniels6813/semantic-release-alpine@master
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
plugins: '<plugin-npm-package-1>@<version> <plugin-npm-package-2>@<version>'
```
### Subsequent steps dependent on a release
## Subsequent steps dependent on a release
```yaml
- id: semantic-release
uses: rdaniels6813/semantic-release-alpine@master
Expand Down

0 comments on commit 85aead5

Please sign in to comment.