Skip to content

Different results when generating a CHANGELOG.md #891

@timurkhisamov

Description

@timurkhisamov

I have a problem with different results when generating the changelog of a project.

As you can see on the screenshot generating the changelog has errors with the order of the pull requests in the releases sections. There was a deletion from one section, an addition to another.

Screenshot 2020-08-19 at 13 08 49

I used next parameters:

My repo is private, I use GitHub API token.
docker run -it --rm -v $pwd:/usr/local/src/your-app ferrarimarco/github-changelog-generator --project=<project> --user=<user> --token=<token> --unreleased_label "Latest:" --release-branch master --no-issues --no-filter-by-milestone

Output:

Using these options:
:date_format=>"%Y-%m-%d"
:output=>"CHANGELOG.md"
:base=>"HISTORY.md"
:issues=>false
:add_issues_wo_labels=>true
:add_pr_wo_labels=>true
:pulls=>true
:filter_issues_by_milestone=>false
:author=>true
:unreleased=>true
:unreleased_label=>"Latest:"
:compare_link=>true
:exclude_labels=>["duplicate", "question", "invalid", "wontfix", "Duplicate", "Question", "Invalid", "Wontfix", "Meta: Exclude From Changelog"]
:summary_labels=>["Release summary", "release-summary", "Summary", "summary"]
:breaking_labels=>["backwards-incompatible", "Backwards incompatible", "breaking"]
:enhancement_labels=>["enhancement", "Enhancement", "Type: Enhancement"]
:bug_labels=>["bug", "Bug", "Type: Bug"]
:deprecated_labels=>["deprecated", "Deprecated", "Type: Deprecated"]
:removed_labels=>["removed", "Removed", "Type: Removed"]
:security_labels=>["security", "Security", "Type: Security"]
:configure_sections=>{}
:add_sections=>{}
:issue_line_labels=>[]
:max_issues=>nil
:simple_list=>false
:ssl_ca_file=>nil
:verbose=>true
:header=>"# Changelog"
:merge_prefix=>"**Merged pull requests:**"
:issue_prefix=>"**Closed issues:**"
:summary_prefix=>""
:breaking_prefix=>"**Breaking changes:**"
:enhancement_prefix=>"**Implemented enhancements:**"
:bug_prefix=>"**Fixed bugs:**"
:deprecated_prefix=>"**Deprecated:**"
:removed_prefix=>"**Removed:**"
:security_prefix=>"**Security fixes:**"
:http_cache=>true
:require=>[]
:project=>"hidden value"
:user=>"hidden value"
:token=>"hidden value"
:release_branch=>"master"

Found 68 tags
Fetching tags dates: 68/68
Sorting tags...
Received issues: 162
Pull Request count: 162
Filtered pull requests: 145
Fetching events for issues and PR: 145
Fetching closed dates for issues: 145/145
Fetching SHAs for tags: 68
Warning: PR 158 merge commit was not found in the release branch or tagged git history and no rebased SHA comment was found
Warning: PR 157 merge commit was not found in the release branch or tagged git history and no rebased SHA comment was found
Warning: PR 156 merge commit was not found in the release branch or tagged git history and no rebased SHA comment was found
Associating PRs with tags: 145/145
Generating entry...
Done!
Generated log placed in /usr/local/src/your-app/CHANGELOG.md

Steps to reproduce:

  • run github-changelog-generator (does not matter using docker or a binary file)
  • git add . && git commit -m "1"
  • then run again github-changelog-generator`
  • git status

In my case, the results are always different, commits jump from one section to another or disappears altogether.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions