forked from google/closure-library
-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathgithub_client.ts
More file actions
143 lines (134 loc) · 3.89 KB
/
Copy pathgithub_client.ts
File metadata and controls
143 lines (134 loc) · 3.89 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
/**
* @license
* Copyright 2020 The Closure Library Authors. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @fileoverview A module that exports a convenience class to interface with the
* GitHub REST API.
*/
import {Octokit} from '@octokit/rest';
/**
* An interface that describes options for the GitHubClient class constructor.
*/
export interface GitHubClientOptions {
/** The owner of the repository. */
owner: string;
/** The repository name. */
repo: string;
/**
* A unique user agent for this application, as requested in GitHub API
* documentation.
*/
userAgent: string;
/**
* A GitHub API token.
*/
token: string;
}
/**
* An interface that describes options for GitHubClient#draftRelease.
*/
export interface DraftReleaseOptions {
/** The name of the tag to associate with this release. */
tagName: string;
/** The commit to tag for this release. */
commit: string;
/** The name of the release. */
name: string;
/** The body text for the release. */
body: string;
/**
* The ID of a draft to update.
* If omitted, a new draft will be created.
*/
id?: number;
}
/**
* A class that provides an stripped-down interface for the GitHub REST API.
*/
export class GitHubClient {
private readonly owner: string;
private readonly repo: string;
private readonly octokit: Octokit;
/**
* Constructs a new GitHubClient.
* @param options Options for constructing this GitHubClient.
*/
constructor({owner, repo, userAgent, token}: GitHubClientOptions) {
this.owner = owner;
this.repo = repo;
this.octokit = new Octokit({
auth: token,
userAgent,
});
}
/**
* Returns the tag associated with the latest GitHub Release.
* @return The tag associated with the latest GitHub Release.
*/
async getLatestReleaseTag() {
const {data} = await this.octokit.repos.getLatestRelease({
owner: this.owner,
repo: this.repo,
});
return data.tag_name;
}
/**
* Gets a list of drafts out of the last 30 releases.
* @return A list of recent drafts.
*/
async getRecentDrafts() {
const {data} = await this.octokit.repos.listReleases({
owner: this.owner,
repo: this.repo,
});
return data.filter((release) => release.draft).map((release) => ({
tagName:
release.tag_name,
id: release.id,
}));
}
/**
* Drafts a new GitHub Release.
* @param options Options for drafting the GitHub Release.
* @return The URL to the GitHub Web UI for managing the drafted release.
*/
async draftRelease({tagName, commit, name, body, id}: DraftReleaseOptions) {
if (id) {
const {data} = await this.octokit.repos.updateRelease({
owner: this.owner,
repo: this.repo,
tag_name: tagName,
target_commitish: commit,
name,
body,
draft: true,
release_id: id,
});
return data.html_url;
} else {
const {data} = await this.octokit.repos.createRelease({
owner: this.owner,
repo: this.repo,
tag_name: tagName,
target_commitish: commit,
name,
body,
draft: true,
});
return data.html_url;
}
}
}