Skip to content

Commit

Permalink
add description of optional notes files for release
Browse files Browse the repository at this point in the history
  • Loading branch information
ktmeaton committed Feb 18, 2021
1 parent 8bc9b1b commit 8e8919d
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# autologs

[![GitHub release](https://img.shields.io/github/release/ktmeaton/autologs/all.svg)](https://GitHub.com/ktmeaton/autologs/releases/)
[![GitHub release](https://img.shields.io/github/release/ktmeaton/autologs/all.svg)](https://github.com/ktmeaton/autologs/releases/)
[![Test](https://github.com/ktmeaton/autologs/actions/workflows/test.yaml/badge.svg)](https://github.com/ktmeaton/autologs/actions/workflows/test.yaml)
[![Lint](https://github.com/ktmeaton/autologs/actions/workflows/lint.yaml/badge.svg)](https://github.com/ktmeaton/autologs/actions/workflows/lint.yaml)

Expand Down Expand Up @@ -84,6 +84,20 @@ $ autologs --release --new-tag v0.1.0 --max-commits 3
* [```ce2fded```](https://github.com/ktmeaton/autologs/commit/ce2fded) fix pr dependency on max commits
```

- The optional section "### Notes" will appear if a notes file matching the tag name exists.
- The notes file must contain an enumerated list of notes.

```yaml
autologs parameters:
--new-tag v0.1.0
--notes-dir docs/notes/

matching file: docs/notes/Notes_v0.1.0.md
1. Create repository
1. Add scripts.
1. Add release workflow.
```
### Changelog
```bash
Expand Down

0 comments on commit 8e8919d

Please sign in to comment.