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

The changelog contains non-merged PRs #3524

Open
stsewd opened this issue Jan 16, 2018 · 11 comments
Open

The changelog contains non-merged PRs #3524

stsewd opened this issue Jan 16, 2018 · 11 comments
Labels
Accepted Accepted issue on our roadmap Improvement Minor improvement to code

Comments

@stsewd
Copy link
Member

stsewd commented Jan 16, 2018

@stsewd stsewd changed the title The changelog contains not merged PR The changelog contains not merged PRs Jan 16, 2018
@stsewd
Copy link
Member Author

stsewd commented Jan 16, 2018

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

@humitos
Copy link
Member

humitos commented Jan 16, 2018

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 humitos added the Improvement Minor improvement to code label Jan 16, 2018
funkyHat pushed a commit to funkyHat/readthedocs.org that referenced this issue Jan 18, 2018
* Allow BUILD_IMAGES to be updated from a setting

Fixes readthedocs#3524

* Styles

* Style updates

Config changes:

 - ignore D107 (__init__ method must have a docstring) in flake8
 - readthedocs and readthedocsinc are marked as FIRSTPARTY in isort
 - readthedocs_build is marked as THIRDPARTY

* Rename setting to DOCKER_BUILD_IMAGES
@agjohnson
Copy link
Contributor

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.

@stsewd stsewd mentioned this issue Feb 13, 2018
@xrmx
Copy link
Contributor

xrmx commented Aug 7, 2018

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.

@stsewd
Copy link
Member Author

stsewd commented Aug 10, 2018

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
Copy link
Member Author

stsewd commented Aug 10, 2018

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

@xrmx
Copy link
Contributor

xrmx commented Aug 10, 2018

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

@stsewd
Copy link
Member Author

stsewd commented Aug 10, 2018

The current changelog contains PRs that just were closed too.

@humitos
Copy link
Member

humitos commented Aug 10, 2018

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

@stsewd
Copy link
Member Author

stsewd commented Aug 13, 2018

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.

@stale
Copy link

stale bot commented Jan 10, 2019

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 stale bot added the Status: stale Issue will be considered inactive soon label Jan 10, 2019
@stsewd stsewd added Accepted Accepted issue on our roadmap and removed Status: stale Issue will be considered inactive soon labels Jan 10, 2019
@agjohnson agjohnson added this to the Development improvements milestone Feb 4, 2019
@stsewd stsewd changed the title The changelog contains not merged PRs The changelog contains non-merged PRs Oct 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Accepted Accepted issue on our roadmap Improvement Minor improvement to code
Projects
None yet
Development

No branches or pull requests

4 participants