Skip to content

Move changelog to a folder and use single file entries#6325

Merged
MartinNowak merged 1 commit intodlang:masterfrom
wilzbach:changelog-folder
Jan 6, 2017
Merged

Move changelog to a folder and use single file entries#6325
MartinNowak merged 1 commit intodlang:masterfrom
wilzbach:changelog-folder

Conversation

@wilzbach
Copy link
Contributor

@wilzbach wilzbach commented Dec 16, 2016

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

@WalterBright
Copy link
Member

I'll defer this to @MartinNowak

@MartinNowak MartinNowak self-assigned this Dec 20, 2016
This will get copied to dlang.org and cleared when master gets
merged into stable prior to a new release.

```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

@wilzbach wilzbach Dec 22, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

you can preview the changelog:

```
../tools/changed.d -o ../dlang.org/changelog/pending.dd && make -C ../dlang.org -f posix.mak html
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep the downsides of having many repos - PR is still pending: dlang/tools#186

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, ok then 👍

@wilzbach
Copy link
Contributor Author

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)

The initial version was a lot more strict and then people demanded to make it more lax :P
I tried to reformulate the example, s.t. it shows more what one can do with ddoc and I guess once there "is more prior art" it should even be more intuitive.

@MartinNowak MartinNowak merged commit 62f5ec1 into dlang:master Jan 6, 2017
@wilzbach wilzbach deleted the changelog-folder branch December 19, 2017 09:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants