Commit 55d9106
authored
Adding the release drafter (#58)
The release drafter is used across Redis clients to provide a baseline
for valuable release notes, across clients. The goal is not to replace
the need to write release notes, but rather to provide a *consistent*
basis, and baseline for those.
As part of this, pull request **titles** upon merge to **master** become
the comment in a release note. A merged pull request needs to have one
of the labels below, thus inserting itself into the right place within
the proposed, future release notes. In no way, does this negate a pull
request appearing in multiple locations, nor enforce label requirements.
The labels are as follows:
bug - A pull request with this label will appear within the bugs
section.
feature - This label ensures the pull request is marked as a feature
maintenance - Documentation changes, CI changes, and basically ongoing
library maintenance work, belong here.
breakingchange - Occasionally, we need to communicate with users, that a
change breaks behaviour, or an API. By tagging accordingly, this appears
at the top of the release notes.
The action itself, is stored in the workflows folder, whereas the
configuration (and hence template) for the github action appears in
.github. The proposed configuration is a direct copy from redis-py, as
these are used everywhere. Finally, as an example of well generated
release notes, for larger changes please see [release
4.5.5](https://github.com/redis/redis-py/releases/tag/v4.5.5)1 parent d2fe303 commit 55d9106
File tree
2 files changed
+72
-0
lines changed- .github
- workflows
2 files changed
+72
-0
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
0 commit comments