Skip to content
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

Doc: Changelog for 0.5.0 release #104

Merged
merged 1 commit into from Apr 26, 2020

Conversation

@andythenorth
Copy link
Contributor

@andythenorth andythenorth commented Apr 25, 2020

This isn't 100%, there may be late additions via #102 and #103.

Known issues:

  • would benefit from consolidation, e.g. some of the 'fix' commits are for features only introduced in this release
  • capitalisation of first word after ':' is inconsistent
  • use of commit prefix is inconsistent, e.g. 'change' commits relate to build environment, don't affect nml end user
  • order is currently by prefix, then alphabetical, rather than by related items from the user's point-of-view, maybe that should be changed?

Some of these we should fix, some aren't a big deal for this time :)

TrueBrain "as it goes: learn from the past, live in the future"

@LordAro
Copy link
Member

@LordAro LordAro commented Apr 25, 2020

#103 should absolutely not block anything, and i'd be tempted to say it shouldn't be in this release anyway, just on the (offchance) it could introduce some different behaviour

@andythenorth andythenorth force-pushed the andythenorth:changelog-0.5.x branch 3 times, most recently from 6b383cb to 4e3da7c Apr 25, 2020
@glx22
Copy link
Contributor

@glx22 glx22 commented Apr 25, 2020

#102 is not vital for a release as the tag will be used in this case.

Copy link
Member

@LordAro LordAro left a comment

IMO.

docs/changelog.txt Outdated Show resolved Hide resolved
docs/changelog.txt Outdated Show resolved Hide resolved
docs/changelog.txt Outdated Show resolved Hide resolved
docs/changelog.txt Outdated Show resolved Hide resolved
docs/changelog.txt Outdated Show resolved Hide resolved
docs/changelog.txt Outdated Show resolved Hide resolved
docs/changelog.txt Outdated Show resolved Hide resolved
docs/changelog.txt Outdated Show resolved Hide resolved
docs/changelog.txt Outdated Show resolved Hide resolved
docs/changelog.txt Outdated Show resolved Hide resolved
docs/changelog.txt Outdated Show resolved Hide resolved
docs/changelog.txt Outdated Show resolved Hide resolved
docs/changelog.txt Outdated Show resolved Hide resolved
docs/changelog.txt Outdated Show resolved Hide resolved
docs/changelog.txt Outdated Show resolved Hide resolved
@andythenorth andythenorth force-pushed the andythenorth:changelog-0.5.x branch from 78db9c8 to f62c9b0 Apr 25, 2020
docs/changelog.txt Show resolved Hide resolved
docs/changelog.txt Show resolved Hide resolved
@andythenorth andythenorth force-pushed the andythenorth:changelog-0.5.x branch 2 times, most recently from 67e487a to 3b32d97 Apr 25, 2020
docs/changelog.txt Outdated Show resolved Hide resolved
@LordAro LordAro changed the title Doc: draft changelog for 0.5.0 release Doc: Changelog for 0.5.0 release Apr 25, 2020
@LordAro LordAro marked this pull request as ready for review Apr 25, 2020
@andythenorth andythenorth force-pushed the andythenorth:changelog-0.5.x branch from 3b32d97 to 23206be Apr 26, 2020
@LordAro
Copy link
Member

@LordAro LordAro commented Apr 26, 2020

The issue is that these are now release notes, rather than a changelog. There's no particular issue to doing it like this, but it's not how we've done any other changelog... ever. Consider splitting it out into a separate RELEASE_NOTES.md file?

@frosch123
Copy link
Member

@frosch123 frosch123 commented Apr 26, 2020

I like the new way.

The old changelog contains stuff like "- Update: Changelog", which is mind-boggling stupid. Link to the VCS log in that case.

Copy link
Member

@frosch123 frosch123 left a comment

This is an exceptional release, which breaks compatibility.
It's unlikely that another release would need so extensive notes in a while. So future minor and patch versions will likely revert to the old brief changelog.
It makes no sense to split this over two files:

  • The brief changelog does not meet the communication requirements of this release.
  • Future releases are unlikely to require extensive notes.
@frosch123 frosch123 dismissed LordAro’s stale review Apr 26, 2020

all out-dated?

@andythenorth andythenorth merged commit b2ee270 into OpenTTD:master Apr 26, 2020
15 checks passed
15 checks passed
Python 3.5 on ubuntu-latest
Details
Python 3.x on ubuntu-latest
Details
Python 3.6 on ubuntu-latest
Details
Python 3.x on macOS-latest
Details
Python 3.7 on ubuntu-latest
Details
Python 3.x on windows-2016
Details
Python 3.8 on ubuntu-latest
Details
Python 3.5 on macOS-latest
Details
Python 3.6 on macOS-latest
Details
Python 3.7 on macOS-latest
Details
Python 3.8 on macOS-latest
Details
Python 3.5 on windows-2016
Details
Python 3.6 on windows-2016
Details
Python 3.7 on windows-2016
Details
Python 3.8 on windows-2016
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

6 participants
You can’t perform that action at this time.