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 release notes #147

Closed
jdussouillez opened this issue Oct 17, 2023 · 3 comments
Closed

Add release notes #147

jdussouillez opened this issue Oct 17, 2023 · 3 comments
Labels
enhancement New feature or request

Comments

@jdussouillez
Copy link
Contributor

I'm starting to use this and it works great, thanks!

But I think it lacks a changelog or release notes file (or using Github milestones). It's hard to know what changed when updating to a new version (new rules, breaking changes, etc).

@yeonjuan yeonjuan added the enhancement New feature or request label Oct 18, 2023
@yeonjuan
Copy link
Owner

yeonjuan commented Oct 18, 2023

Hi @jdussouillez. I agree. Thanks for the suggestion!
It would be nice to automate the recording of information about changes in GitHub releases. To accomplish this, To accomplish this, I think the following tasks should be accomplished. If you know of any good ideas or tools, I'd love to hear about them.

@jdussouillez
Copy link
Contributor Author

If you know of any good ideas or tools, I'd love to hear about them

I use Conventional Commits but I don't use auto generated release notes in Github.

Tip: I use a Git hook to prevent myself from committing invalid messages (in complement of the Github action check): https://github.com/conventional-changelog/commitlint#add-hook

@yeonjuan
Copy link
Owner

Hi @jdussouillez I made first release note, and we'll be writing one for every release going forward. Thank you. see https://github.com/yeonjuan/html-eslint/releases

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

No branches or pull requests

2 participants