Skip to content

Commit bb476de

Browse files
authored
Update README (#8)
1 parent aaae7e0 commit bb476de

File tree

1 file changed

+25
-11
lines changed

1 file changed

+25
-11
lines changed

README.md

Lines changed: 25 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,20 @@
1212
[![All Contributors](https://img.shields.io/badge/all_contributors-21-orange.svg?style=flat-square)](#contributors-)
1313
<!-- ALL-CONTRIBUTORS-BADGE:END -->
1414

15+
Updates:
16+
17+
Since this package was forked, many changes have been made to support my particular use-case.
18+
19+
- I only desire to make changelogs based on merged PRs.
20+
- I feel that the process should be idempotent, so I focus on rebuilding the entire file each time.
21+
- The order of the commits/PRs should be in descending order and none should be excluded.
22+
- The produced file should pass a markdown linter (e.g. markdownlint)
23+
- For compatibility with release tools, the PRs that have landed since the last tag should be included.
24+
- The latest version number should appear at the top of the changelog.
25+
- Because not all commits you need to track changes of have PRs (security vulnerabilities), there is an `overridePrs` config value for which you can specify PRs to be included.
26+
- It should return a function that returns a list of PRs.
27+
- It will be passed the current list of PRs.
28+
1529
## OK, what can `gren` do for me?
1630

1731
`gren` is a small helpful robot that will do for you just create a release from a tag and compile the release notes using issues or commits.
@@ -38,17 +52,17 @@ The process, [as explained here](https://help.github.com/articles/creating-relea
3852
Let `gren` take care of that for you. It automates this process and also writes release notes for you, creating something like this:
3953

4054
> ## v0.6.0 (14/03/2017)
41-
>
42-
> #### Framework Enhancements:
43-
>
55+
>
56+
> #### Framework Enhancements
57+
>
4458
> - [#32](https://github.com/github-tools/github-release-notes/issues/32) Unwrap github-api promises
4559
> - [#26](https://github.com/github-tools/github-release-notes/issues/26) Use external config file
4660
> - [#23](https://github.com/github-tools/github-release-notes/issues/23) Introduce templates for the issues
4761
> - [#19](https://github.com/github-tools/github-release-notes/issues/19) Add an "ignore label" flag
4862
> - [#12](https://github.com/github-tools/github-release-notes/issues/12) Add the chance to rebuild the history of release notes
49-
>
50-
> #### Bug Fixes:
51-
>
63+
>
64+
> #### Bug Fixes
65+
>
5266
> - [#29](https://github.com/github-tools/github-release-notes/issues/29) Remove escaping character on regex
5367
> - [#24](https://github.com/github-tools/github-release-notes/issues/24) The changelog action doesn't compile latest release
5468
@@ -86,13 +100,13 @@ Even though it doesn't require a machine-readable commit, it is still better to
86100
The output then uses commit messages (title + description) to look something like:
87101

88102
> ## v0.9.0 (17/05/2017)
89-
>
103+
>
90104
> - Filter milestones (#75)
91-
> * Create milestones data-source option
92-
> * Add documentation for the milestones option
105+
> - Create milestones data-source option
106+
> - Add documentation for the milestones option
93107
> - Support GitHub enterprise (#73)
94-
> * Support GitHub enterprise
95-
> * Add api-url to options documentation
108+
> - Support GitHub enterprise
109+
> - Add api-url to options documentation
96110
> - Update CHANGELOG.md
97111
98112
#### Help 🤖 to write wonderful stuff (commits)

0 commit comments

Comments
 (0)