zoriya/octokit.net
1
0
Fork 0
mirror of https://github.com/zoriya/octokit.net.git synced 2026-06-01 10:25:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add NewRelease.GenerateReleaseNotes property (#2596)

Browse Source 
* Add `GenerateReleaseNotes` property

Enable generating release notes during creation of a release.

* Update release docs
This commit is contained in:
Matt
2022-10-18 01:38:50 -04:00
committed by GitHub
parent d68fc27c13
commit 7b6d57af33
3 changed files with 28 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/releases.md
+12 -4
View File
@@ -8,8 +8,8 @@ To retrieve all releases for a repository:
var releases = await client.Repository.Release.GetAll("octokit", "octokit.net");
var latest = releases[0];
Console.WriteLine(
"The latest release is tagged at {0} and is named {1}",
latest.TagName,
"The latest release is tagged at {0} and is named {1}",
latest.TagName,
latest.Name);
```
@@ -35,6 +35,14 @@ Note that the `Draft` flag is used to indicate when a release should be publishe
GitHub can generate a name and body for a new release [automatically](https://github.blog/2021-10-04-beta-github-releases-improving-release-experience/#introducing-auto-generated-release-notes), based upon merged pull requests.
[This is an example](https://github.com/MylesBorins/release-notes-test/releases/tag/v2.0.0) of automatically generated text.
```csharp
var newTag = "v1.5.7";
var newRelease = new NewRelease(newTag);
newRelease.GenerateReleaseNotes = true; // Set for Name and Body to be generated.
newRelease.TargetCommitish = "main"; // Optional, can be a branch, tag, or SHA; defaults to the main branch.
```
#### Customizing generated notes
```csharp
var newTag = "v1.5.7";
var generationRequest = new GenerateReleaseNotesRequest(newTag);
@@ -47,7 +55,7 @@ newRelease.Name = releaseNotes.Name;
newRelease.Body = releaseNotes.Body;
```
This feature can be customized at the repository level, by following [these instructions](https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes#configuring-automatically-generated-release-notes).
This feature can be customized at the repository level, by following [these instructions](https://docs.github.com/repositories/releasing-projects-on-github/automatically-generated-release-notes#configuring-automatically-generated-release-notes).
### Update
@@ -68,7 +76,7 @@ If you have any assets to include with the release, you can upload them after cr
```csharp
using(var archiveContents = File.OpenRead("output.zip")) { // TODO: better sample
var assetUpload = new ReleaseAssetUpload()
var assetUpload = new ReleaseAssetUpload()
{
FileName = "my-cool-project-1.0.zip",
ContentType = "application/zip",