Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.
And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.
Improve changelog
See original GitHub issueWe currently use the shipkit-changelog Gradle plugin to generate changelogs for releases. For example, this is the generated changelog for v1.7.0:
1.7.0
- 2022-04-10 - 10 commit(s) by Daniel Kraus, Filip Hrisafov, Marcono1234, Matthias Bünger, Mihály Verhás, Nicolai Parlog
- Fix Java version for release job (#620)
- Remove CLA (#616)
- Inherit default locale and timezone annotations (#615)
- Update JUnit to 5.8 (#594 / #612) (#612)
- Update to JDK 11 (#608)
- Update JDK used for builds (#606)
- Add
nameattribute for@RetryingTest(#601)- Update JUnit to 5.8 (#594)
- Add CLA-Bot (#591)
- Fix most compiler warnings (#565)
- Align use of extension point (#496)
- Support JSON as source for parametrized tests arguments (#492)
- Enclosing classes vs Before/AfterAll (#479)
- Support JSON as source for parameterized tests arguments (#101)
- Replace Upstream Test Code With Dependency (#6)
As can be seen, and as described in the plugin’s readme, the generated “[…] changelog [is] based on commit history and Github pull requests/issues”.
In contrast to other changelog generators such as release-drafter or GitHub native, there seem to be little to no configuration options? Something I consider a problem is, e.g., the missing ability to filter tags like theme: build, as this can be confusing to users. For example, the changelog entry “Update to JDK 11 (#608)” let this user think v1.7.0 can only be used with Java 11+.
We should (i) discuss how we can improve our changelog and (ii) if such improvements can be done with shipkit-changelog, or if we require other tooling.
Issue Analytics
- State:
- Created a year ago
- Comments:9 (9 by maintainers)
Top Results From Across the Web
Top Related Medium Post
Top Related StackOverflow Question
Troubleshoot Live Code
Top Related Reddit Thread
Top Related Hackernoon Post
Top Related Tweet
Top Related Dev.to Post
Top Related Hashnode Post
@nipafx I don’t think I will find time soon. I will remove it from the milestone, so it doesn’t block our progress towards 2.0.
I did use “Keep a Changelog” in some other projects and we (me and my teammates) often forgot to update the
CHANGELOG.md. It also caused merge conflicts sometimes.I believe it is easier for us to leverage our already nice PR titles/descriptions and labels, and generate the changelog. We already have
type: new featureandtype: bugfor categorizing the changelog entries, but we would need at least one more label to opt-out a change from the changelog.PS: GitHub can now render mathematical expressions, so I do this (because I can):
$e^{\pi i} + 1 = 0$
See also: Euler’s identity