Move changelog to a folder and use single file entries#6325
Move changelog to a folder and use single file entries#6325MartinNowak merged 1 commit intodlang:masterfrom
Conversation
|
I'll defer this to @MartinNowak |
| This will get copied to dlang.org and cleared when master gets | ||
| merged into stable prior to a new release. | ||
|
|
||
| ``` |
There was a problem hiding this comment.
I'm just trying to add the changelog for druntime PR and I find this very confusing. Is what follows the content of the file? If so, what's the name of the file? Maybe add more documentation around here.
There was a problem hiding this comment.
I find this very confusing
Please see dlang/phobos#4228 for the motivation and examples.
Is what follows the content of the file?
Yes.
If so, what's the name of the file?
There's no fixed file name scheme except that the extension should be .dd (Ddoc extension).
Maybe add more documentation around here.
Ok - Will do so later.
There was a problem hiding this comment.
Please see dlang/phobos#4228 for the motivation and examples.
Sorry, the intention was not confusing, but more how should I use it :-). As being one that wasn't involved in the motivation/examples, I just wanted to say that the README is confusing as it doesn't provide clear guidelines what one should do (and there's no prior art in the same repo to rip it off)
changelog/README.md
Outdated
| you can preview the changelog: | ||
|
|
||
| ``` | ||
| ../tools/changed.d -o ../dlang.org/changelog/pending.dd && make -C ../dlang.org -f posix.mak html |
There was a problem hiding this comment.
This doesn't seems to work with freshly copied dlang/tools repository:
nemanjaboric@labs-129:/home/nemanjaboric/work/druntime git:(fiber-protection*) $ ../tools/changed.d -o ../dlang.org/changelog/pending.dd && make -C ../dlang.org -f posix.mak html
Usage: ./changed <revision range>, e.g. ./changed v2.067.1..upstream/stable
There was a problem hiding this comment.
Yep the downsides of having many repos - PR is still pending: dlang/tools#186
There was a problem hiding this comment.
Ah, ok then 👍
2e9c2e9 to
a8c1a4f
Compare
The initial version was a lot more strict and then people demanded to make it more lax :P |
Single files allow to enforce that every PR comes with a changelog as one can't run into a merge conflicts.
For DMD the idea was to move the language changelog directly to dlang.org, s.t. the DMD repo only contains the compiler changes.
For more details, see dlang/tools#186