Renovate: Allow custom release notes mapping

Created on 14 Sep 2018  Â·  7Comments  Â·  Source: renovatebot/renovate

What would you like Renovate to be able to do?
Several packages do not get release notes shown on the pull request description. Searching for the release notes online takes too much time (for example the js firebase package release notes are in https://firebase.google.com/support/release-notes/js

Describe the solution you'd like
Please let us configure custom mappings, eg firebase => https://firebase.google.com/support/release-notes/js . If it's difficult to parse and populate the PR description with the notes from custom links, just showing the link will be fine.

priority-4-low feature

Most helpful comment

This has been implemented as part of code, with firebase on npmjs being the first and only package with a manual mapping.

All 7 comments

It's a good idea, although I need to think about how to achieve it. For common ones like Firebase I'd expect that the mapping should be built into Renovate and not require you to configure it yourself.

Right now we use the terms homepage and repositoryUrl where the latter points to a source repository where we attempt download notes/releases from there. Instead as you propose we'd now want a simple link to release notes for cases like Firefox, e.g. we might call it changelogUrl.

This has been implemented as part of code, with firebase on npmjs being the first and only package with a manual mapping.

:tada: This issue has been resolved in version 13.65.0 :tada:

The release is available on:

Your semantic-release bot :package::rocket:

@rarkins sorry, I must have misunderstood the usage convention. How do you use changelogUrls ?

renovate.json

{
  "extends": [
    "config:base"
  ],
  …
  "changelogUrls": {
    "firebase": "https://firebase.google.com/support/release-notes/js",
    "flow-bin": "https://github.com/facebook/flow/blob/master/Changelog.md"
  }
}

@Fandekasp right now it's hardcoded in source code as I think any URLs would apply to all users anyway. I've created a PR just now for flow-bin: https://github.com/renovatebot/renovate/pull/2534

oh ok... there are lots of repos with custom changelogs, so making a PR on
renovate everytime doesn't sound very scalable.
But alright, I'll do that, thanks for the quick reply

On Tue, Sep 18, 2018 at 5:01 PM Rhys Arkins notifications@github.com
wrote:

@Fandekasp https://github.com/Fandekasp right now it's hardcoded in
source code as I think any URLs would apply to all users anyway. I've
created a PR just now for flow-bin: #2534
https://github.com/renovatebot/renovate/pull/2534

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
https://github.com/renovatebot/renovate/issues/2520#issuecomment-422294895,
or mute the thread
https://github.com/notifications/unsubscribe-auth/AAP7dwkFBGtH2riUBM4vuGnEeINOYIXmks5ucKhUgaJpZM4Wod5e
.

Well, as shown in that PR - it's just a one-line PR necessary, so really about the same work as adding it to your config anyway, and this way everyone else will get it as a bonus.

Was this page helpful?
0 / 5 - 0 ratings