Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add breaking changes to GitHub release notes #2268

Open
oprogramador opened this issue Jun 15, 2020 · 9 comments
Open

Add breaking changes to GitHub release notes #2268

oprogramador opened this issue Jun 15, 2020 · 9 comments

Comments

@oprogramador
Copy link

oprogramador commented Jun 15, 2020

The release notes on GitHub are currently empty. It would be beneficial if these contained the breaking changes for each major release. Currently these are only showing in the github repo.

This is about hooking into the release scripts and pushing the changes to the Github releases using the Github API. Start by investigating how the release script works by looking at the scripts in package.json and then how to extract the relevant parts from the changelog markdown file. The github API is quite easy to grok.

@stale
Copy link

stale bot commented Aug 16, 2020

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale label Aug 16, 2020
@oprogramador
Copy link
Author

IMO stale bot doesn't work correctly. The issue could be closed if I get an answer and there's a lack of activity on my side but not in this case when I've got no answer.

@mroderick
Copy link
Member

IMO stale bot doesn't work correctly. The issue could be closed if I get an answer and there's a lack of activity on my side but not in this case when I've got no answer.

I agree. stale-bot is not quite there yet.

I've added the "pinned" label, which means that stale-bot should leave it alone. Let's see how it goes :)

@rnd-debug
Copy link

Hello. I would like to contribute, but is this open for external contributions?
I assume that:

  • this issue requires to update CHANGELOG.md ?
  • the needed info is to be found in docs/guides/migrating-to-X.0.md ?

@fatso83
Copy link
Contributor

fatso83 commented Oct 21, 2020

@rnd-debug that seems correct. And every file is open for contributions 🙂

Just try and build the webpage first, and then things hopefully starts making sense 👍

@rnd-debug
Copy link

@fatso83 sorry, but i am still confused. I went quickly through the docs/guides/migrating-to-X.0.md and it seems to me that everything from those files is already mentioned in the ROOT/CHANGELOG.md.
So is the task actually about:

@fatso83
Copy link
Contributor

fatso83 commented Oct 23, 2020

The releases page is generated. You don't have to do anything there. And so the "git view". That is just an overview of the tags. Just have a look at the source code for the releases page and it should be apparent.

@fatso83
Copy link
Contributor

fatso83 commented Oct 23, 2020

Ah, sorry, I have been misled about what this concerns. I read your initial questions and thought it actually had to do with the homepage releases. After pressing the link in the issue description I see that this has nothing to do with the home page at all!

This is about hooking into the release scripts and pushing the changes to the Github releases using the Github API. Something very different indeed 😃 Start by investigating how this works by looking at the scripts in package.json and then how to extract the relevant parts from the changelog. The github API is quite easy to grok at least.

@fatso83
Copy link
Contributor

fatso83 commented May 25, 2021

Editing the description of this to reflect what is needed to be done.

@fatso83 fatso83 changed the title missing breaking changes in release notes Add breaking changes to GitHub release notes May 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants