Skip to content

Add 2.10 changes to CHANGELOG; minor release follow-ups - #2229

Merged
eamonnmcmanus merged 5 commits into
google:masterfrom
Marcono1234:marcono1234/release-follow-up
Oct 30, 2022
Merged

Add 2.10 changes to CHANGELOG; minor release follow-ups#2229
eamonnmcmanus merged 5 commits into
google:masterfrom
Marcono1234:marcono1234/release-follow-up

Conversation

@Marcono1234

@Marcono1234 Marcono1234 commented Oct 25, 2022

Copy link
Copy Markdown
Contributor

Not sure though if it is worth keeping both the CHANGELOG.md and the GitHub releases up to date.

@Marcono1234
Add 2.10 changes to CHANGELOG; minor release follow-ups
b3bb7b1
@Marcono1234
Use GitHub URLs in CHANGELOG
4f32f7c 
GitHub automatically displays them only as short reference with link and
additionally shows a preview when hovering over them.
@Marcono1234
Add id to pom.xml developer entry
85233ae 
Otherwise BND plugin shows a warning.
Marcono1234
Marcono1234 commented Oct 25, 2022
View reviewed changes
Comment thread pom.xml
Marcono1234
Marcono1234 commented Oct 25, 2022
View reviewed changes
Comment thread pom.xml
@Marcono1234
Marcono1234 marked this pull request as draft October 25, 2022 21:20
eamonnmcmanus
eamonnmcmanus approved these changes Oct 25, 2022
View reviewed changes

@eamonnmcmanus eamonnmcmanus left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks!

Comment thread pom.xml
Comment thread pom.xml
@eamonnmcmanus

eamonnmcmanus commented Oct 25, 2022

Copy link
Copy Markdown
Member

Indeed, in some other Google projects we have given up on maintaining a change log since it is redundant with the GitHub release notes.

@Marcono1234
Marcono1234 marked this pull request as ready for review October 25, 2022 22:25
@Marcono1234

Marcono1234 commented Oct 25, 2022

Copy link
Copy Markdown
Contributor Author

Indeed, in some other Google projects we have given up on maintaining a change log since it is redundant with the GitHub release notes.

Would you prefer to do this here as well? We could keep CHANGELOG.md around for the previous releases, but at the beginning of it mention that for newer versions the changelog is documented on the GitHub releases.

@eamonnmcmanus

eamonnmcmanus commented Oct 30, 2022

Copy link
Copy Markdown
Member

To keep things simple, why don't we merge this PR and then make a separate PR that adds some text to the top of CHANGELOG.md explaining that releases past 2.10 won't be documented there.

@eamonnmcmanus
eamonnmcmanus merged commit ff96296 into google:master Oct 30, 2022
@Marcono1234 Marcono1234 mentioned this pull request Oct 30, 2022
Merged
@Marcono1234
Marcono1234 deleted the marcono1234/release-follow-up branch October 30, 2022 18:54
@Marcono1234

Marcono1234 commented Oct 30, 2022

Copy link
Copy Markdown
Contributor Author

Have created #2230 for that. I hope that is what you had in mind, if not feel free to suggest adjustments.

tibor-universe pushed a commit to getuniverse/gson that referenced this pull request Nov 26, 2022
@Marcono1234 @tibor-universe
Add 2.10 changes to CHANGELOG; minor release follow-ups (google#2229)
d5fa0d3 
* Add 2.10 changes to CHANGELOG; minor release follow-ups

* Use GitHub URLs in CHANGELOG

GitHub automatically displays them only as short reference with link and
additionally shows a preview when hovering over them.

* Add `id` to pom.xml developer entry

Otherwise BND plugin shows a warning.

* Run unit tests during release preparation

* Move git option before pathspec
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@eamonnmcmanus eamonnmcmanus eamonnmcmanus approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Marcono1234 @eamonnmcmanus