/
Config.ts
54 lines (52 loc) · 1.48 KB
/
Config.ts
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
import { OctokitOptions } from '@octokit/core/dist-types/types.d';
export interface GitHubRepository {
/**
* The name of your repository
*/
name: string;
/**
* The owner of your repository, this is either your username or the name of
* the organization that owns the repository.
*/
owner: string;
}
export interface PublisherGitHubConfig {
/**
* Details that identify your repository (name and owner)
*/
repository: GitHubRepository;
/**
* An authorization token with permission to upload releases to this
* repository.
*
* You can set the GITHUB_TOKEN environment variable if you don't want to hard
* code this into your config.
*/
authToken?: string;
/**
* This options object is directly passed to \@octokit/rest so you can
* customize any of the options that module uses. This is particularly
* helpful for publishing to GitHub Enterprise servers.
*/
octokitOptions?: OctokitOptions;
/**
* Whether or not this release should be tagged as a prerelease
*/
prerelease?: boolean;
/**
* Whether or not this release should be tagged as a draft
*/
draft?: boolean;
/**
* Prepended to the package version to determine the release name (default "v")
*/
tagPrefix?: string;
/**
* Re-upload the new asset if you upload an asset with the same filename as existing asset
*/
force?: boolean;
/**
* Whether to automatically generate release notes for the release
*/
generateReleaseNotes?: boolean;
}