Skip to content

Commit

Permalink
Merge pull request #9 from patrickjahns/update_docs
Browse files Browse the repository at this point in the history
Update docs
  • Loading branch information
patrickjahns authored Mar 1, 2020
2 parents 6c46ac0 + 10872b9 commit b250bcf
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

To use the action, create a yaml file ( i.e. `version.yml` ) in your `.github/workflows` folder

### Standalone Example
### Standalone example

```yaml

Expand Down Expand Up @@ -66,6 +66,17 @@ jobs:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
### Configuration
The action determines the next semantic version based on github labels. The mapping of the labels can be configured by
providing a yaml configuration (usually at `.github/version-drafter.yml`)

```yaml
major-labels: ['semver:major']
minor-labels: ['semver:minor','enhancement']
patch-labels: ['semver:patch','bug']
```

### Output

The action will output the calculated next semantic version as `next-version`

0 comments on commit b250bcf

Please sign in to comment.