progress icon indicating copy to clipboard operation
progress copied to clipboard

Add change log file.

Open skywinder opened this issue 8 years ago • 2 comments

Hi, as I can see, you carefully fill tags and labels for issues in your repo.

For such cases I create a github_changelog_generator, that generate change log file based on tags, issues and merged pull requests from :octocat: Issue Tracker.

This PR add change log file to your repo (generated by this script). You can check, how it looks like here: Change Log

Some essential features, that has this script:

  • it exclude not-related to changelog issues (any issue, that has label question duplicate invalid wontfix )
  • Distinguish issues according labels:
    • Merged pull requests (all merged pull-requests)
    • Bug fixes (by label bug in issue)
    • Enhancements (by label enhancement in issue)
    • Issues (closed issues w/o any labels)
  • Generate neat Change Log file according basic change log guidelines.

You can quickly update this file in future with the simple run script: github_changelog_generator Xfennec/progress in your repo folder, and it makes your Change Log file up-to-date again!

Hope you find this commit as useful. :wink:

skywinder avatar Nov 21 '17 21:11 skywinder

Nice tool! But there's an issue for us, sadly: my own commits won't be reported in the changelog. My workflow is probably broken (any advice on this, anybody ?) but I don't branch+pr+merge for the changes I do myself, therefore those changes are not reported in the generated changelog.

Xfennec avatar Nov 22 '17 08:11 Xfennec

@Xfennec it does not include commits by itself, because of it usually overloaded with technical staff. But we will do support of commits by regex in the future, to pick corresponding commits: here is a feature request about that: https://github.com/skywinder/github-changelog-generator/issues/51

skywinder avatar Nov 28 '17 14:11 skywinder