Skip to content

Commit 0465cda

Browse files
xt0rtedxt0rted
authored
Support auto generating release notes (softprops#179)
1 parent 69a9b03 commit 0465cda

File tree

5 files changed

+59
-12
lines changed

5 files changed

+59
-12
lines changed

‎README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,7 @@ The following are optional as `step.with` keys
179179
| `target_commitish` | String | Commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. |
180180
| `token` | String | Secret GitHub Personal Access Token. Defaults to `${{ github.token }}` |
181181
| `discussion_category_name` | String | If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see ["Managing categories for discussions in your repository."](https://docs.github.com/en/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository) |
182+
| `generate_release_notes` | Boolean | Whether to automatically generate the name and body for this release. If name is specified, the specified name will be used; otherwise, a name will be automatically generated. If body is specified, the body will be pre-pended to the automatically generated notes. |
182183

183184
💡 When providing a `body` and `body_path` at the same time, `body_path` will be
184185
attempted first, then falling back on `body` if the path can not be read from.

‎__tests__/util.test.ts

Lines changed: 43 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,8 @@ describe("util", () => {
5050
input_name: undefined,
5151
input_tag_name: undefined,
5252
input_target_commitish: undefined,
53-
input_discussion_category_name: undefined
53+
input_discussion_category_name: undefined,
54+
input_generate_release_notes: false
5455
})
5556
);
5657
});
@@ -69,7 +70,8 @@ describe("util", () => {
6970
input_name: undefined,
7071
input_tag_name: undefined,
7172
input_target_commitish: undefined,
72-
input_discussion_category_name: undefined
73+
input_discussion_category_name: undefined,
74+
input_generate_release_notes: false
7375
})
7476
);
7577
});
@@ -88,7 +90,8 @@ describe("util", () => {
8890
input_name: undefined,
8991
input_tag_name: undefined,
9092
input_target_commitish: undefined,
91-
input_discussion_category_name: undefined
93+
input_discussion_category_name: undefined,
94+
input_generate_release_notes: false
9295
})
9396
);
9497
});
@@ -119,7 +122,8 @@ describe("util", () => {
119122
input_tag_name: undefined,
120123
input_fail_on_unmatched_files: false,
121124
input_target_commitish: undefined,
122-
input_discussion_category_name: undefined
125+
input_discussion_category_name: undefined,
126+
input_generate_release_notes: false
123127
}
124128
);
125129
});
@@ -142,7 +146,8 @@ describe("util", () => {
142146
input_tag_name: undefined,
143147
input_fail_on_unmatched_files: false,
144148
input_target_commitish: "affa18ef97bc9db20076945705aba8c516139abd",
145-
input_discussion_category_name: undefined
149+
input_discussion_category_name: undefined,
150+
input_generate_release_notes: false
146151
}
147152
);
148153
});
@@ -164,10 +169,36 @@ describe("util", () => {
164169
input_tag_name: undefined,
165170
input_fail_on_unmatched_files: false,
166171
input_target_commitish: undefined,
167-
input_discussion_category_name: "releases"
172+
input_discussion_category_name: "releases",
173+
input_generate_release_notes: false
168174
}
169175
);
170176
});
177+
178+
it("supports generating release notes", () => {
179+
assert.deepStrictEqual(
180+
parseConfig({
181+
INPUT_GENERATE_RELEASE_NOTES: "true"
182+
}),
183+
{
184+
github_ref: "",
185+
github_repository: "",
186+
github_token: "",
187+
input_body: undefined,
188+
input_body_path: undefined,
189+
input_draft: undefined,
190+
input_prerelease: undefined,
191+
input_files: [],
192+
input_name: undefined,
193+
input_tag_name: undefined,
194+
input_fail_on_unmatched_files: false,
195+
input_target_commitish: undefined,
196+
input_discussion_category_name: undefined,
197+
input_generate_release_notes: true
198+
}
199+
);
200+
});
201+
171202
it("prefers GITHUB_TOKEN over token input for backwards compatibility", () => {
172203
assert.deepStrictEqual(
173204
parseConfig({
@@ -189,7 +220,8 @@ describe("util", () => {
189220
input_tag_name: undefined,
190221
input_fail_on_unmatched_files: false,
191222
input_target_commitish: undefined,
192-
input_discussion_category_name: undefined
223+
input_discussion_category_name: undefined,
224+
input_generate_release_notes: false
193225
}
194226
);
195227
});
@@ -213,7 +245,8 @@ describe("util", () => {
213245
input_tag_name: undefined,
214246
input_fail_on_unmatched_files: false,
215247
input_target_commitish: undefined,
216-
input_discussion_category_name: undefined
248+
input_discussion_category_name: undefined,
249+
input_generate_release_notes: false
217250
}
218251
);
219252
});
@@ -236,7 +269,8 @@ describe("util", () => {
236269
input_tag_name: undefined,
237270
input_fail_on_unmatched_files: false,
238271
input_target_commitish: undefined,
239-
input_discussion_category_name: undefined
272+
input_discussion_category_name: undefined,
273+
input_generate_release_notes: false
240274
}
241275
);
242276
});

‎action.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,9 @@ inputs:
4040
discussion_category_name:
4141
description: "If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. If there is already a discussion linked to the release, this parameter is ignored."
4242
required: false
43+
generate_release_notes:
44+
description: "Whether to automatically generate the name and body for this release. If name is specified, the specified name will be used; otherwise, a name will be automatically generated. If body is specified, the body will be pre-pended to the automatically generated notes."
45+
required: false
4346
env:
4447
"GITHUB_TOKEN": "As provided by Github Actions"
4548
outputs:

‎src/github.ts

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ export interface Releaser {
4444
prerelease: boolean | undefined;
4545
target_commitish: string | undefined;
4646
discussion_category_name: string | undefined;
47+
generate_release_notes: boolean | undefined;
4748
}): Promise<{ data: Release }>;
4849

4950
updateRelease(params: {
@@ -57,6 +58,7 @@ export interface Releaser {
5758
draft: boolean | undefined;
5859
prerelease: boolean | undefined;
5960
discussion_category_name: string | undefined;
61+
generate_release_notes: boolean | undefined;
6062
}): Promise<{ data: Release }>;
6163

6264
allReleases(params: {
@@ -89,6 +91,7 @@ export class GitHubReleaser implements Releaser {
8991
prerelease: boolean | undefined;
9092
target_commitish: string | undefined;
9193
discussion_category_name: string | undefined;
94+
generate_release_notes: boolean | undefined;
9295
}): Promise<{ data: Release }> {
9396
return this.github.rest.repos.createRelease(params);
9497
}
@@ -104,6 +107,7 @@ export class GitHubReleaser implements Releaser {
104107
draft: boolean | undefined;
105108
prerelease: boolean | undefined;
106109
discussion_category_name: string | undefined;
110+
generate_release_notes: boolean | undefined;
107111
}): Promise<{ data: Release }> {
108112
return this.github.rest.repos.updateRelease(params);
109113
}
@@ -193,6 +197,7 @@ export const release = async (
193197
: "");
194198

195199
const discussion_category_name = config.input_discussion_category_name;
200+
const generate_release_notes = config.input_generate_release_notes;
196201
try {
197202
// you can't get a an existing draft by tag
198203
// so we must find one in the list of all releases
@@ -254,7 +259,8 @@ export const release = async (
254259
body,
255260
draft,
256261
prerelease,
257-
discussion_category_name
262+
discussion_category_name,
263+
generate_release_notes
258264
});
259265
return release.data;
260266
} catch (error) {
@@ -282,7 +288,8 @@ export const release = async (
282288
draft,
283289
prerelease,
284290
target_commitish,
285-
discussion_category_name
291+
discussion_category_name,
292+
generate_release_notes
286293
});
287294
return release.data;
288295
} catch (error) {

‎src/util.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ export interface Config {
1717
input_fail_on_unmatched_files?: boolean;
1818
input_target_commitish?: string;
1919
input_discussion_category_name?: string;
20+
input_generate_release_notes?: boolean;
2021
}
2122

2223
export const uploadUrl = (url: string): string => {
@@ -65,7 +66,8 @@ export const parseConfig = (env: Env): Config => {
6566
input_fail_on_unmatched_files: env.INPUT_FAIL_ON_UNMATCHED_FILES == "true",
6667
input_target_commitish: env.INPUT_TARGET_COMMITISH || undefined,
6768
input_discussion_category_name:
68-
env.INPUT_DISCUSSION_CATEGORY_NAME || undefined
69+
env.INPUT_DISCUSSION_CATEGORY_NAME || undefined,
70+
input_generate_release_notes: env.INPUT_GENERATE_RELEASE_NOTES == "true"
6971
};
7072
};
7173

0 commit comments

Comments
 (0)