Merge release 3.1.3 into 3.2.x

github-actions[bot] commented 4 years ago

Release Notes for 3.1.3

3.1.3

Total issues resolved: 0
Total pull requests resolved: 1
Total contributors: 1

Documentation,Enhancement

13: Adds new page for installation to documentation thanks to @froschdesign

tux-rampage commented 4 years ago

Should this be part of the changelog/milestone?

Ocramius commented 4 years ago

Of the milestone: yes.

Of the changelog, not sure 🤷‍♀️

tux-rampage commented 4 years ago

Of the changelog, not sure :woman_shrugging:

Since this is part of the Milestone, automatic releases will add it to the changelog then, right (perfectly fine for me)?

Ocramius commented 4 years ago

Yes. Just no point in having it in CHANGELOG.md IMO

On Wed, Sep 16, 2020, 23:44 Axel H. notifications@github.com wrote:

Of the changelog, not sure 🤷‍♀️

Since this is part of the Milestone, automatic releases will add it to the changelog then, right (perfectly fine for me)?

— You are receiving this because your review was requested. Reply to this email directly, view it on GitHub https://github.com/laminas/laminas-di/pull/14#issuecomment-693682093, or unsubscribe https://github.com/notifications/unsubscribe-auth/AABFVEEQNRJIO4HZTGNWGZTSGEWVDANCNFSM4RONRK3A .

tux-rampage commented 4 years ago

Yes. Just no point in having it in CHANGELOG.md IMO

You mean a manual entry within CHANGELOG.md, right? Does it make sense to maintain manual entries at all? As far as I can see, they will be completely replaced when automatic releases run, or am I missing something?

weierophinney commented 4 years ago

Does it make sense to maintain manual entries at all? As far as I can see, they will be completely replaced when automatic releases run, or am I missing something?

I've noted in another comment why I think it's important. When it comes to automatic-releases, it actually does quite a bit:

It creates release notes via jwage/changelog-generator
If the changelog entry has no changes listed, it replaces the contents with the above.
If changes ARE present:
- It removes any section where the sole bullet point is - Nothing..
- It appends the generated release notes from the first steps to the entry.

In each of the above cases, it also sets the release date, writes the contents to the file, commits it, and pushes it up to the repo. The contents are then also used for the tag and release.

So, no, it doesn't just overwrite the manually entered notes.

We'll likely leave it up to each maintainer if they want to continue using a CHANGELOG.md file, though we'll recommend it, particularly for the reasons I outlined above (communicating to consumers about what changed, why, and what steps they may need to take).

I'd go and merge. Any objections?

Nope - go for it!

tux-rampage commented 4 years ago

When the existing items from changelog are merged with the generated one, this makes perfect sense. I didn't know this was the case. Thanks for clearification. 👍

geerteltink commented 4 years ago

From the DCO check details page:

Commit sha: 2bf302e, Author: Laminas Bot, Committer: Laminas Bot; The sign-off is missing.

@weierophinney does this mean the Laminas Bot needs to sign-off as well?

froschdesign commented 4 years ago

@geerteltink Quote from the chat (contributors channel):

You don't need to worry about the DCO checks for auto-generated commits/merges, since we can trace them back to the bot.

weierophinney commented 4 years ago

From the DCO check details page:

Commit sha: 2bf302e, Author: Laminas Bot, Committer: Laminas Bot; The sign-off is missing.

@weierophinney does this mean the Laminas Bot needs to sign-off as well?

It's a potential improvement to the bot, but not required. We don't need DCO for merge commits or those with obvious changes.

laminas / laminas-di