You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
+
15
29
## OK, what can `gren` do for me?
16
30
17
31
`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
38
52
Let `gren` take care of that for you. It automates this process and also writes release notes for you, creating something like this:
0 commit comments