-
Notifications
You must be signed in to change notification settings - Fork 412
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
changelog creator #8195
changelog creator #8195
Conversation
#8195 (b7eb3ed) changes the metrics as follows in comparison to Benchmark: defaultTest: dune monorepo benchmarks
|
b7eb3ed
to
d16aff5
Compare
Is it something that you'd find interesting to have in |
Sure, we could have a feature where dune-release looks at |
Please note that there is no UNRELEASED file in this PR, but rather a directory with separate files for the entries. There is an action that prepends all of them. Having separate files allows us to completely avoid merge conflicts which are a bit menial to resolve. |
Quick observation: I think it would be useful if the helper script were to save my username (or at least have it as an CLI option), given my GH username is rather long and prone to typos. |
d16aff5
to
0a9e8c2
Compare
@Leonidas-from-XIV I've changed it so that the username is always written to All of this behaviour is in the cram test. |
aaf2985
to
9529a14
Compare
9529a14
to
c64daaf
Compare
Signed-off-by: Ali Caglayan <alizter@gmail.com>
c64daaf
to
72cae15
Compare
I'm closing this until @emillon wants to use this. |
This PR adds an interactive script that adds a changelog entry to
doc/changes/
. This can be invoked usingThe script will ask you some (optional) information about your change / PR and then create the entry file. It comes with a small cram test about its basic behaviour. The changelog entry is correctly formatted and laid out etc.
Another rule with alias
@compile-changelog
will compile the changes indoc/changes
and diff them to theCHANGES.md
changelog. This is meant to be called during each release. This can be invoked usingThis will run this rule which will diff. This can be then promoted.
%{deps}
being unable to expand incat
action. (The compile rule relies on this). test: expand %{deps} in (cat) #8196Motivation
Having a single CHANGES.md file is nice and simple, but it causes a lot of unnecessary work when rebasing and resolving conflicts.
This PR solves both these issues by making each entry its own file and leaving it to the release master to compile the end changelog.