search

yarnpkg / yarn

The 1.x line is frozen - features and bugfixes now happen on https://github.com/yarnpkg/berry
https://classic.yarnpkg.com
Other
41.43k stars 2.72k forks source link

Enhancing releases section of the Repo to be information rich #7309

Open zenithworks opened 5 years ago

zenithworks commented 5 years ago

Hi, I came across the releases section of this repository, it looks like there is a scope to enhance it to be more informative for developers. Currently each releases contains only the binaries and do not display any information about the changes incorporated in the release. It would be great if we could just copy the contents of changelog as release notes or just provide a link to the changelog.

Since the repo already uses Azure pipelines for CI, we can leverage its built-in task to publish release notes to GitHub. The task can be configured to create a release only when the pipeline is triggered for a matching tag. Also, it can take the contents of a file that's checked into repository and add it as the release notes. Optionally, we can display a link to changelog file as well in the release notes. I took a shot at configuring this: Pipeline , Repo

image

Here is a sample repo that leverages this capability.

PS: I am a PM for azure pipelines. I would be happy to help with the changes :)

zenithworks commented 5 years ago

@arcanis

zenithworks commented 5 years ago

@arcanis - would love to know your thoughts on this.

arcanis commented 5 years ago

Oh, sorry! Just started a new job, I was a bit underwater 😃

Conceptually I'm all for it - one thing to keep in mind though is that we're hard at work on the v2, and that while the v1 isn't left to die it'll probably enter more of a maintenance mode (where we fix critical bugs etc but don't plan new features on it). In this context maybe the efforts aren't worth the results 🤷‍♀️

That said, if it can be done if a few lines then let's do this. How hard would it be to do this?:

Also, it can take the contents of a file that's checked into repository and add it as the release notes.

zenithworks commented 5 years ago

It is easy to do this, just needs few steps to be added to azure-pipelines.yml file. You can see the changes in my fork, i can raise a pull request for the same.