Skip to content
This repository has been archived by the owner on Mar 23, 2024. It is now read-only.

Consider using conventional-changelog to generate changelog #1563

Closed
stevemao opened this issue Jul 24, 2015 · 7 comments
Closed

Consider using conventional-changelog to generate changelog #1563

stevemao opened this issue Jul 24, 2015 · 7 comments

Comments

@stevemao
Copy link
Contributor

we have conventional-changelog or conventional-github-releaser (there are also grunt/gulp tasks) to automate the process of writing the changelog. As you are using formatted commit messages so the logs can be generated well according to the parts of the message. We use handlebars for templating the logs. It can also ignore reverted commits. There are many other features. We have a jquery preset for people using jquery commit format.
The modules are actively maintained.

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

@stevemao
Copy link
Contributor Author

Sample logs generated based on your commits

AlignedObjectValues

AnonymousFunctionExpression

API

  • allow external entities to be defined without "jscs" prefix (8b0ac2c)

Autofix

  • remove merge artefact (c617a58)
  • support disallowTrailingComma rule (7b4212a)
  • support trailing whitespaces and missing commas (5f2370e), closes #1479

Checker

  • more API changes for 2.0 (83baef5)
  • remove deprecated constructor options (2d5745f)

CLI

Configuration

  • add "getConfiguredRule" method (6bdf65d)
  • add ability to load external presets (7246452), closes #109 #1083
  • allow "getReporter" method to require node modules (ce1a877), closes #1030
  • exclude node_modules/ by default (1ba4b45), closes #1461 #1467
  • improve JSDoc notes (41e0c58)
  • initial pass on the polymorphic require (6fc7b41)
  • simplify and modulize configuration module (6bdacb1), closes #1150
  • small corrections to JSDoc of "node-configuration" module (87956be)
  • small refactoring of the configuration module (c2c5a9b)

@mrjoelkemp
Copy link
Member

This is pretty great! Thanks for the recommendation @stevemao.

I assume we'd have to tweak the handlebars templates to get this sample closer to what we produce for our changelogs. We like giving authors credit and grouping all Rule-related changes under a rules section – instead of a section per rule.

This is definitely a +1 from me to try integrating it into the build flow.

@stevemao Do you have the command that you used to generate our changelogs handy?

@stevemao
Copy link
Contributor Author

I can definitely tweak the templates for you. I will create a jscs preset as the jquery preset may not be suitable.
It would be great if you could create requirements with a sample changelog.

The sample log I generated was using conventional-changelog -p jquery but once jscs preset is done you can do conventional-changelog -p jscs. To regenerate all previous logs, use conventional-changelog -p jscs -r 0. Again there are grunt/gulp wrappers if you are already using them so you don't need to use the cli.

@hzoo
Copy link
Member

hzoo commented Oct 16, 2015

What do we need to do now to use this? I'm ok with manually tweaking the changelog after running npm run changelog now like in the past few releases so it's not too big for me

@stevemao
Copy link
Contributor Author

I have pushed several new releases and a ton of bugs have fixed. Would you still consider using it?

@hzoo hzoo added the revisit label Feb 26, 2016
@hzoo hzoo closed this as completed Feb 26, 2016
@stevemao
Copy link
Contributor Author

@hzoo Hmmm... Not interested?

@hzoo
Copy link
Member

hzoo commented Feb 26, 2016

Not at the moment, just closing things that we can come back to

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

No branches or pull requests

3 participants