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

release post script breaking without ### Notable Changes #802

Closed
MylesBorins opened this issue Jun 23, 2016 · 8 comments
Closed

release post script breaking without ### Notable Changes #802

MylesBorins opened this issue Jun 23, 2016 · 8 comments

Comments

@MylesBorins
Copy link
Contributor

If a release post does not include### Notable Changes the tool blows up

@lpinca
Copy link
Member

lpinca commented Jun 24, 2016

I think it makes sense to always include a ### Notable Changes section even if it is a security only release. For example this is what @rvagg did with 0.12.15 and 0.10.46:

@phillipj
Copy link
Member

IMO the release script should never stand in the way of getting a release post out the door asap. Ideally it would be forgiving and try to do as best as it can, and maybe print a warning or two if something is missing. Of course it simplifies the release post script if could be confident the changelog is formatted correctly, but that would imply linting the changelog somehow before it's merged into core.

@lpinca
Copy link
Member

lpinca commented Jun 25, 2016

The changelog should definitely be linted before being commited.
I agree that the release script should be forgiving but to a certain degree. If an important section is missing, for example, it should throw an error, like it does now.

@lpinca
Copy link
Member

lpinca commented Jun 25, 2016

Ref: nodejs/node#7394.

@lpinca
Copy link
Member

lpinca commented Jul 24, 2016

It was like this (no Notable Changes -> error) even before the script had been updated to handle the new changelog structure.
I still think that this is the correct behavior but I'm fine with changing it to handle cases where "Notable Changes" is missing.

@fhemberger
Copy link
Contributor

@thealphanerd @lpinca Does this issue still exist?

@MylesBorins
Copy link
Contributor Author

MylesBorins commented Dec 16, 2016 via email

@lpinca
Copy link
Member

lpinca commented Dec 17, 2016

Yeah but the tool was designed to do this.
I mean it errors if there isn't a "### Notable Changes" section. It was like this from the beginning.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants