search

balena-io / balena-sdk

The SDK to make balena powered JavaScript applications.
https://www.balena.io/
Apache License 2.0
145 stars 46 forks source link

Add method for generating link to OS changelog #392

Open LucianBuzzo opened 6 years ago

LucianBuzzo commented 6 years ago

The method should take a device type slug and an optional version, and return a link to the CHANGELOG.md file for the device's OS.

sdk.models.os.getChangelogLink('beaglebone-black') 
# --> https://github.com/resin-os/resin-beaglebone/blob/master/CHANGELOG.md

sdk.models.os.getChangelogLink('intel-edison', 'v2.3.0+rev1') 
# --> https://github.com/resin-os/resin-edison/blob/master/CHANGELOG.md#v230rev1

Connects to https://github.com/resin-os/resinos/issues/380 and https://github.com/resin-io/resin-ui/issues/1191

pimterry commented 6 years ago

I'm not sure this should live in the SDK. Thoughts?

LucianBuzzo commented 6 years ago

I mulled this over for a bit, I think it makes sense for this to live in the sdk as it's a useful utility for the CLI as well. I could see it being valuable in our support integrations as well.