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 support for github generated changelogs #51

Closed
ahatzz11 opened this issue Jun 16, 2022 · 1 comment · Fixed by #52
Closed

Add support for github generated changelogs #51

ahatzz11 opened this issue Jun 16, 2022 · 1 comment · Fixed by #52

Comments

@ahatzz11
Copy link
Contributor

Github allows for automatically generated changelogs on a release: https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes#configuring-automatically-generated-release-notes

This is available through their CLI gh tool as --generate-release-notes. Looking at this repo a bit it seems like it uses the API so that has an option too: https://docs.github.com/en/rest/releases/releases#generate-release-notes-content-for-a-release

It would be awesome if this library had something similar, something maybe like

githubRelease {
    repo("repo")
    tagName(semver.versionTagName)
    body(autoGenerated())               // <-- something like this
}

I might be able to help with this contribution depending on if it's something that would be possible to do 👍

@ahatzz11
Copy link
Contributor Author

I took a stab at this in #52 👀

The implementation changed a bit from what I first imagined since github natively supports this on the POST call.

githubRelease {
    generateReleaseNotes(true)
}

BreadMoirai added a commit that referenced this issue Jun 17, 2022
…ease-notes

Add support for github generated release notes, closes #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 a pull request may close this issue.

1 participant