github-preview-updater/src/types/config.ts at 7db4fe3fd261b1e7cc3c52dae98b5bdcea6dbbfe · TheDragonCode/github-preview-updater · GitHub

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
export interface ImageParameters {
    pattern: string;
    style: string;
    fontSize: string;
    icon: string;

    packageManager: "composer" | "npm" | "yarn" | "auto" | "none";
    packageName?: string;
    packageGlobal: boolean;

    title?: string;
    description?: string;
}

export interface Image {
    url: string;
    parameters: ImageParameters;
}

export interface Author {
    name: string;
    email: string;
}

export interface Commit {
    branch: string;
    title: string;
    body?: string;
    author: Author;
}

export interface PullRequest {
    title: string;
    body?: string;
    assignees: string[];
    labels: string[];
}

export interface Repository {
    owner?: string;
    repo?: string;
    octokit?: any;

    commit: Commit;
    pullRequest: PullRequest;
}

export interface Path {
    readme: string;
}

export interface Config {
    directory?: string;
    path: Path;

    image: Image;
    repository: Repository;
}

export const defaultConfig: Config = {
    directory: undefined,
    path: {
        readme: "README.md",
    },

    image: {
        url: "https://banners.beyondco.de/{title}.png",

        parameters: {
            pattern: "topography",
            style: "style_2",
            fontSize: "100px",
            icon: "code",

            packageManager: "auto",
            packageGlobal: false,
            packageName: undefined,

            title: undefined,
            description: undefined,
        },
    },

    repository: {
        owner: undefined,
        repo: undefined,

        commit: {
            branch: "preview-{random}",
            title: "docs(preview): Update preview",
            body: undefined,

            author: {
                name: "github-actions",
                email: "github-actions@github.com",
            },
        },

        pullRequest: {
            title: "Update preview",
            body: undefined,
            assignees: [],
            labels: [],
        },
    },
};