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 method for GET /{owner}/{repo}/releases/notes #2171

Open
2 tasks done
marcindabrowski opened this issue Nov 22, 2021 · 2 comments
Open
2 tasks done

Add method for GET /{owner}/{repo}/releases/notes #2171

marcindabrowski opened this issue Nov 22, 2021 · 2 comments
Labels
Type: Feature New feature or request

Comments

@marcindabrowski
Copy link

Please avoid duplicates

What’s missing?

Recently the ability to automatically generate release notes for GitHub releases has been added.
When enabled in the project the body can be obtained using GET to below endpoint:

https://github.com/{owner}/{repo}/releases/notes?commitish={commitish}&tag_name={tag_name}

Please add it to your API.

Why?

Using the automatically generated body of the release obtained by requested new API, it will be possible to automate release creation with Create a release API.

Alternatives you tried

It is a new API, so there are no alternatives.

Would you be interested in contributing the feature?

  • yes
@marcindabrowski marcindabrowski added the Type: Feature New feature or request label Nov 22, 2021
@wolfy1339
Copy link
Member

Thanks for taking the time to fill out the template and requesting this feature!

Unfortunately, the endpoints methods are automatically generated from GitHub's OpenAPI spec, we don't add new endpoints ourselves.

If GitHub hasn't added the endpoint yet, it won't be available for use in this module.

Currently there aren't any updates to @octokit JS packages, as there is no active maintainer.

You can subscribe to this discussion for any further updates.

@wolfy1339
Copy link
Member

In the meantime, you can use the enpoint manually using the octokit.request() function

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Feature New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants