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

GenerateReleaseNotes will have no effect in RepositoriesService.EditRelease #2444

Closed
coro opened this issue Aug 24, 2022 · 2 comments · Fixed by #2445
Closed

GenerateReleaseNotes will have no effect in RepositoriesService.EditRelease #2444

coro opened this issue Aug 24, 2022 · 2 comments · Fixed by #2445
Assignees

Comments

@coro
Copy link
Contributor

coro commented Aug 24, 2022

According to the GitHub v3 API reference, generate_release_notes is not a recognised body parameter of the endpoint to update a release. In this library, the value of
RepositoryRelease.GenerateReleaseNotes is passed to the PATCH request to the GitHub API regardless, where it will have no effect.

From what I can tell, RepositoryRelease.GenerateReleaseNotes will only have an effect when calling RepositoriesService.CreateRelease, whereas the comments imply that it has an effect everywhere.

I recognise this field can't have an effect until there is a change in the GitHub API; I think what I would prefer in the meantime would be an update to the code/documentation in this library to make it clear that RepositoriesService.UpdateRelease will not cause release note generation, as this was rather confusing to me when trying to consume this function in a downstream library.

@gmlewis
Copy link
Collaborator

gmlewis commented Aug 24, 2022

Thank you, @coro . Would you like to prepare the PR?

@coro
Copy link
Contributor Author

coro commented Aug 24, 2022

Will do, Glenn, thank you!

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 a pull request may close this issue.

2 participants