Skip to content

Provide a way to link to release notes #46

@philwebb

Description

@philwebb

Hi, this is a first-timers-only issue. This means we've worked to make it more legible to folks who either haven't contributed to our codebase before, or even folks who haven't contributed to open source before.

If that's you, we're interested in helping you take the first step and can answer questions and help you out as you do. Note that we're especially interested in contributions from people from groups underrepresented in free and open source software!

If you have contributed before, consider leaving this one for someone new, and looking through our general ideal-for-contribution issues. Thanks!

Problem

The changelog generator does not have a way to add external links to it. For example, when a new version of Spring Boot is released, it is accompanied by release notes on the Github Wiki. It would be nice if the changelog could point to these release notes so that they are easy to discover.

Solution

Add an option to add external links at the bottom of the changelog. These links should be configurable using a property as follows:

changelog:
  external_links:
  - name: Release notes
    location: https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-2.3-Release-Notes

The content for the changelog is generated here. The tests for verifying the output can be found here.


## Steps to Fix 
 
- [ ] Claim this issue with a comment below and ask any clarifying questions you need
- [ ] Set up a repository locally following the [Contributing Guidelines](https://github.com/spring-io/github-changelog-generator/blob/master/CONTRIBUTING.adoc)
- [ ] Try to fix the issue following the steps above
- [ ] Commit your changes and start a pull request.

Metadata

Metadata

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions