Replace manually maintained release notes by link to GitHub by slawekjaranowski · Pull Request #214 · apache/maven-pmd-plugin
Following this checklist to help us incorporate your
contribution quickly and easily:
- Your pull request should address just one issue, without pulling in other changes.
- Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- Each commit in the pull request should have a meaningful subject line and body.
Note that commits might be squashed by a maintainer on merge. - Write unit tests that match behavioral changes, where the tests fail if the changes to the runtime are not applied.
This may not always be possible but is a best-practice. - Run
mvn verifyto make sure basic checks pass.
A more thorough check will be performed on your pull request automatically. - You have run the integration tests successfully (
mvn -Prun-its verify).
If your pull request is about ~20 lines of code you don't need to sign an
Individual Contributor License Agreement if you are unsure
please ask on the developers list.
To make clear that you license your contribution under
the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.
- I hereby declare this contribution to be licenced under the Apache License Version 2.0, January 2004
- In any other case, please file an Apache Individual Contributor License Agreement.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approve, but we know that we loose history of the pre-Github time, right?
Approve, but we know that we loose history of the pre-Github time, right?
If needed, they can be generated automatically.
I did a bit of historic release notes for few others plugin using something such (in maven-dependency-plugin git directory with gh tool)
gh release create -d -t 3.15.0 --generate-notes maven-pmd-plugin-3.15.0
I let you imagine how it's possible to have scripts for this :)
Back in the time, we were not using PRs, the generated release notes would be empty except including a raw changelog link.
Approve, but we know that we loose history of the pre-Github time, right?
If needed, they can be generated automatically. I did a bit of historic release notes for few others plugin using something such (in maven-dependency-plugin git directory with
ghtool)
in manually release notes we have history from 3.9.0, in GitHub releases is from 3.16.0
in Jira we have releases from 2.x
so I can generate a few missing in GH and will be the same
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters