readthedocs.org icon indicating copy to clipboard operation
readthedocs.org copied to clipboard

Published 20 hours ago • verified publisher icon readthedocs

The changelog contains non-merged PRs

Open stsewd opened this issue 7 years ago • 11 comments

Details

Chagelog http://docs.readthedocs.io/en/latest/changelog.html#version-2-1-4

Not merged PRs:

  • #3444
  • #3463
  • #3377
  • #2699

How is the changelog generated?

stsewd avatar Jan 16 '18 19:01 stsewd

Also the previous release contains invalid issues as changelog: #3416, #3415

stsewd avatar Jan 16 '18 19:01 stsewd

How is the changelog generated?

The changelog is generated with a script that is under a private repository. It uses this tool in the back, https://github.com/agjohnson/github-changelog

This is relatively new and we are testing it. Nice you have found some issues! This will help us to tweak it a little more and make it more robust.

humitos avatar Jan 16 '18 19:01 humitos

My above fork should be easy to modify. I think eventually we want the search to only include pull requests that have been merged. The script currently searches for anything that has been closed, which is noisy. I've been hand editing the list of issues on release for now.

agjohnson avatar Jan 23 '18 05:01 agjohnson

Haven't looked at the code but the script should add only PR that has been merged to master branch, currently all the PR merged are listed.

xrmx avatar Aug 07 '18 10:08 xrmx

There is an option for that already https://github.com/agjohnson/github-changelog/blob/1915b5b24d1b0840eb15f5e07bcce0cd8c5e08a7/index.js#L31, we only need to modify how the script is called

stsewd avatar Aug 10 '18 17:08 stsewd

And we already pass that option https://github.com/rtfd/common/blob/ae892294342da555c90f69c6594277b0c546ede3/tasks.py#L89... @agjohnson how we really run the script?

stsewd avatar Aug 10 '18 17:08 stsewd

@stsewd that switch checks for issues with merged PR not merged to master branch.

xrmx avatar Aug 10 '18 20:08 xrmx

The current changelog contains PRs that just were closed too.

stsewd avatar Aug 10 '18 20:08 stsewd

@stsewd the script is called via invoke prepare $RELEASE_VERSION and that prepare function is executed.

humitos avatar Aug 10 '18 23:08 humitos

I take a look at the chagelog repo, the logic seems correct, but it is using a deprecated package to pull the information https://www.npmjs.com/package/github, maybe it was a bug or the api was changed. So, maybe we want to look for an alternative or use the latest version of the original repo.

stsewd avatar Aug 13 '18 17:08 stsewd

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] avatar Jan 10 '19 16:01 stale[bot]