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

Changelog #17

Closed
bebraw opened this issue Jun 29, 2016 · 5 comments
Closed

Changelog #17

bebraw opened this issue Jun 29, 2016 · 5 comments

Comments

@bebraw
Copy link
Contributor

bebraw commented Jun 29, 2016

Stub.

Feel free to comment here if you have ideas on what this guide should cover. Link to potential resources too.

@bebraw bebraw modified the milestone: Webpack 2 - Documentation MVP Jul 10, 2016
@bebraw bebraw changed the title Support - Changelog Changelog Jul 24, 2016
@kentcdodds
Copy link
Member

This could be automated if the project follows a commit message convention. You could encourage contributors to follow it, but because of GitHub's squash and merge feature, you can change the commit message of people's contributions if they don't follow the convention, which means it wont be a barrier to contributing.

It's incredibly nice to be able to automate the creation of a changelog using git commit messages. You can update the changelog manually if you want after the automation has created it.

Personally, I'd say using semantic-release would be the best because it'll automate releases for you too. But if you'd prefer to not do that, then you can use clog.

@bebraw
Copy link
Contributor Author

bebraw commented Aug 6, 2016

Yup. I'm not sure if we end up maintaining a changelog at the site even. Perhaps the easiest thing to do would be to link to GitHub releases page and solve it there.

I agree automation would be good, but this is up to @sokra to figure out.

@joshwiens
Copy link
Member

@bebraw - conventional-changelog + semantic-release + enforcing commit message formatting ( Committizen does this) === Automated changelog generation and versioning.

Nothing to figure out here as the path forward is pretty standard. Angular / Material2 and a host of other major libs have already blazed this trail.

The above is currently being implemented in karma-webpack

@TheLarkInn
Copy link
Member

Wow I really like @d3viant0ne suggestion of Committizen. That could take a lot of leg work out of the process for some folks. Could be highly useful

@bebraw
Copy link
Contributor Author

bebraw commented Oct 5, 2016

Let's solve this with a link to GitHub releases for the MVP.

@bebraw bebraw closed this as completed in 2b3deda Oct 5, 2016
sallar pushed a commit to sallar/webpack.js.org that referenced this issue Oct 19, 2016
dear-lizhihua referenced this issue in docschina/webpack.js.org Jan 8, 2017
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