support linking to discussions (#136)

* support linking to discussions

* fmt

* wire param
This commit is contained in:
Doug Tangren 2021-08-08 02:07:02 -04:00 committed by GitHub
parent dd98a235fd
commit 2861dc8673
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 57 additions and 14 deletions

View File

@ -49,7 +49,8 @@ describe("util", () => {
input_files: [], input_files: [],
input_name: undefined, input_name: undefined,
input_tag_name: undefined, input_tag_name: undefined,
input_target_commitish: undefined input_target_commitish: undefined,
input_discussion_category_name: undefined
}) })
); );
}); });
@ -67,7 +68,8 @@ describe("util", () => {
input_files: [], input_files: [],
input_name: undefined, input_name: undefined,
input_tag_name: undefined, input_tag_name: undefined,
input_target_commitish: undefined input_target_commitish: undefined,
input_discussion_category_name: undefined
}) })
); );
}); });
@ -85,7 +87,8 @@ describe("util", () => {
input_files: [], input_files: [],
input_name: undefined, input_name: undefined,
input_tag_name: undefined, input_tag_name: undefined,
input_target_commitish: undefined input_target_commitish: undefined,
input_discussion_category_name: undefined
}) })
); );
}); });
@ -104,7 +107,8 @@ describe("util", () => {
input_name: undefined, input_name: undefined,
input_tag_name: undefined, input_tag_name: undefined,
input_fail_on_unmatched_files: false, input_fail_on_unmatched_files: false,
input_target_commitish: undefined input_target_commitish: undefined,
input_discussion_category_name: undefined
}); });
}); });
@ -125,7 +129,30 @@ describe("util", () => {
input_name: undefined, input_name: undefined,
input_tag_name: undefined, input_tag_name: undefined,
input_fail_on_unmatched_files: false, input_fail_on_unmatched_files: false,
input_target_commitish: "affa18ef97bc9db20076945705aba8c516139abd" input_target_commitish: "affa18ef97bc9db20076945705aba8c516139abd",
input_discussion_category_name: undefined
}
);
});
it("supports discussion category names", () => {
assert.deepStrictEqual(
parseConfig({
INPUT_DISCUSSION_CATEGORY_NAME: "releases"
}),
{
github_ref: "",
github_repository: "",
github_token: "",
input_body: undefined,
input_body_path: undefined,
input_draft: undefined,
input_prerelease: undefined,
input_files: [],
input_name: undefined,
input_tag_name: undefined,
input_fail_on_unmatched_files: false,
input_target_commitish: undefined,
input_discussion_category_name: "releases"
} }
); );
}); });
@ -149,7 +176,8 @@ describe("util", () => {
input_name: undefined, input_name: undefined,
input_tag_name: undefined, input_tag_name: undefined,
input_fail_on_unmatched_files: false, input_fail_on_unmatched_files: false,
input_target_commitish: undefined input_target_commitish: undefined,
input_discussion_category_name: undefined
} }
); );
}); });
@ -172,7 +200,8 @@ describe("util", () => {
input_name: undefined, input_name: undefined,
input_tag_name: undefined, input_tag_name: undefined,
input_fail_on_unmatched_files: false, input_fail_on_unmatched_files: false,
input_target_commitish: undefined input_target_commitish: undefined,
input_discussion_category_name: undefined
} }
); );
}); });
@ -194,7 +223,8 @@ describe("util", () => {
input_name: undefined, input_name: undefined,
input_tag_name: undefined, input_tag_name: undefined,
input_fail_on_unmatched_files: false, input_fail_on_unmatched_files: false,
input_target_commitish: undefined input_target_commitish: undefined,
input_discussion_category_name: undefined
} }
); );
}); });

View File

@ -37,13 +37,16 @@ inputs:
target_commitish: target_commitish:
description: "Commitish value that determines where the Git tag is created from. Can be any branch or commit SHA." description: "Commitish value that determines where the Git tag is created from. Can be any branch or commit SHA."
required: false required: false
discussion_category_name:
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."
required: false
env: env:
"GITHUB_TOKEN": "As provided by Github Actions" "GITHUB_TOKEN": "As provided by Github Actions"
outputs: outputs:
url: url:
description: 'URL to the Release HTML Page' description: "URL to the Release HTML Page"
id: id:
description: 'Release ID' description: "Release ID"
upload_url: upload_url:
description: "URL for uploading assets to the release" description: "URL for uploading assets to the release"
runs: runs:

2
dist/index.js vendored

File diff suppressed because one or more lines are too long

View File

@ -43,6 +43,7 @@ export interface Releaser {
draft: boolean | undefined; draft: boolean | undefined;
prerelease: boolean | undefined; prerelease: boolean | undefined;
target_commitish: string | undefined; target_commitish: string | undefined;
discussion_category_name: string | undefined;
}): Promise<{ data: Release }>; }): Promise<{ data: Release }>;
updateRelease(params: { updateRelease(params: {
@ -55,6 +56,7 @@ export interface Releaser {
body: string | undefined; body: string | undefined;
draft: boolean | undefined; draft: boolean | undefined;
prerelease: boolean | undefined; prerelease: boolean | undefined;
discussion_category_name: string | undefined;
}): Promise<{ data: Release }>; }): Promise<{ data: Release }>;
allReleases(params: { allReleases(params: {
@ -86,6 +88,7 @@ export class GitHubReleaser implements Releaser {
draft: boolean | undefined; draft: boolean | undefined;
prerelease: boolean | undefined; prerelease: boolean | undefined;
target_commitish: string | undefined; target_commitish: string | undefined;
discussion_category_name: string | undefined;
}): Promise<{ data: Release }> { }): Promise<{ data: Release }> {
return this.github.rest.repos.createRelease(params); return this.github.rest.repos.createRelease(params);
} }
@ -100,6 +103,7 @@ export class GitHubReleaser implements Releaser {
body: string | undefined; body: string | undefined;
draft: boolean | undefined; draft: boolean | undefined;
prerelease: boolean | undefined; prerelease: boolean | undefined;
discussion_category_name: string | undefined;
}): Promise<{ data: Release }> { }): Promise<{ data: Release }> {
return this.github.rest.repos.updateRelease(params); return this.github.rest.repos.updateRelease(params);
} }
@ -185,6 +189,8 @@ export const release = async (
(isTag(config.github_ref) (isTag(config.github_ref)
? config.github_ref.replace("refs/tags/", "") ? config.github_ref.replace("refs/tags/", "")
: ""); : "");
const discussion_category_name = config.input_discussion_category_name;
try { try {
// you can't get a an existing draft by tag // you can't get a an existing draft by tag
// so we must find one in the list of all releases // so we must find one in the list of all releases
@ -246,7 +252,8 @@ export const release = async (
name, name,
body, body,
draft, draft,
prerelease prerelease,
discussion_category_name
}); });
return release.data; return release.data;
} catch (error) { } catch (error) {
@ -273,7 +280,8 @@ export const release = async (
body, body,
draft, draft,
prerelease, prerelease,
target_commitish target_commitish,
discussion_category_name
}); });
return release.data; return release.data;
} catch (error) { } catch (error) {

View File

@ -16,6 +16,7 @@ export interface Config {
input_prerelease?: boolean; input_prerelease?: boolean;
input_fail_on_unmatched_files?: boolean; input_fail_on_unmatched_files?: boolean;
input_target_commitish?: string; input_target_commitish?: string;
input_discussion_category_name?: string;
} }
export const uploadUrl = (url: string): string => { export const uploadUrl = (url: string): string => {
@ -62,7 +63,8 @@ export const parseConfig = (env: Env): Config => {
? env.INPUT_PRERELEASE == "true" ? env.INPUT_PRERELEASE == "true"
: undefined, : undefined,
input_fail_on_unmatched_files: env.INPUT_FAIL_ON_UNMATCHED_FILES == "true", input_fail_on_unmatched_files: env.INPUT_FAIL_ON_UNMATCHED_FILES == "true",
input_target_commitish: env.INPUT_TARGET_COMMITISH input_target_commitish: env.INPUT_TARGET_COMMITISH,
input_discussion_category_name: env.INPUT_DISCUSSION_CATEGORY_NAME
}; };
}; };