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 change log file. #99

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

skywinder
Copy link

@skywinder skywinder commented Nov 21, 2017

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. 😉

@Xfennec
Copy link
Owner

Xfennec commented Nov 22, 2017

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.

@skywinder
Copy link
Author

skywinder commented Nov 28, 2017

@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: github-changelog-generator/github-changelog-generator#51

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

Successfully merging this pull request may close these issues.

2 participants