beautifultable icon indicating copy to clipboard operation
beautifultable copied to clipboard

Changelog should be moved to a separate file outside of README

Open pri22296 opened this issue 3 years ago • 3 comments

pri22296 avatar Jul 20 '20 19:07 pri22296

Do you want to use semantic release for this task? This will maintain all the diffs between the releases and generates a CHANGELOG.md with the info you are maintaining in README. Some words from their README semantic-release automates the whole package release workflow including: determining the next version number, generating the release notes, and publishing the package. https://github.com/semantic-release/semantic-release But you need to follow their commit guidelines.

Agent-Hellboy avatar Mar 31 '22 15:03 Agent-Hellboy

While the package looks interesting, right now it isn't too much of a hassle to maintain the change log due to relatively low volume of changes post 1.0 release. This issue was more about having the changelog in a separate document while still showing it in the documentation on the home page. If we do integrate this package, imo we would also need to update the build process to fail any PRs/commits not adhering to the guidelines. I'll keep this suggestion open but I feel it's not worth it right now.

pri22296 avatar Mar 31 '22 16:03 pri22296

Fair enough

Agent-Hellboy avatar Mar 31 '22 17:03 Agent-Hellboy