Refactor Config handling: streamline inputs parsing, enhance readConfig logic, and expand Config schema for improved repository configuration management

Author: andrey-helldar

src/main.ts

@@ -1,29 +1,28 @@
-import { cwd } from './utils/filesystem'
+import { cwd, readConfig } from './utils/filesystem'
 import { context } from '@actions/github'
 import { parse } from './utils/inputs'
 import { info } from '@actions/core'
+import { Config } from './types/config'
 
 const previewUpdater = async () => {
-    // Inputs
-
+    // Welcome
     info(`Working directory: ${ cwd }`)
 
-    const { owner, repo: repoName } = context.repo
-
+    // Inputs
     const {
         token,
-        path,
-        branchName,
-        commitTitle,
-        commitBody,
-        commitAuthorName,
-        commitAuthorEmail,
-        pullRequestTitle,
-        pullRequestBody,
-        assignees,
-        labels
+        configPath
     } = parse()
 
+    // Load Config
+    const config = readConfig(<Config>{
+        repository: {
+            owner: context.repo.owner,
+            repo: context.repo.repo,
+            token: token
+        }
+    }, configPath)
+
     // Authenticate
     const repo = new Repository(owner, repoName, token)
     await repo.authenticate(commitAuthorName, commitAuthorEmail)

src/types/config.ts

@@ -19,14 +19,57 @@ export interface Image
     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;
+    token: string;
+
+    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: '',
+    path: {
+        readme: 'README.md'
+    },
 
     image: {
         url: 'https://banners.beyondco.de/{title}.png',
@@ -44,5 +87,29 @@ export const defaultConfig: Config = {
             title: '',
             description: ''
         }
+    },
+
+    repository: {
+        owner: '',
+        repo: '',
+        token: '',
+
+        commit: {
+            branch: 'preview/update-{timestamp}',
+            title: 'docs(preview): Update preview',
+            body: '',
+
+            author: {
+                name: 'github-actions',
+                email: 'github-actions@github.com'
+            }
+        },
+
+        pullRequest: {
+            title: 'Update preview',
+            body: '',
+            assignees: [],
+            labels: []
+        }
     }
 }

src/utils/filesystem.ts

@@ -29,14 +29,14 @@ export const writeFile = (config: Config, filename: string, content: string): vo
     fs.writeFileSync(filePath(config, filename), content)
 }
 
-export const readConfig = (config: Config, path: string = ''): Config => {
-    const content = readFile(config, path || '.github/preview-updater.yml')
+export const readConfig = (config: Config, userConfigPath: string): Config => {
+    const content = readFile(defaultConfig, userConfigPath)
 
     if (content === '') {
-        return defaultConfig
+        return <Config>deepmerge(defaultConfig, config)
     }
 
     const userConfig = <Config>yaml.load(content)
 
-    return <Config>deepmerge(defaultConfig, userConfig)
+    return <Config>deepmerge(defaultConfig, userConfig, config)
 }

src/utils/inputs.ts

@@ -5,101 +5,18 @@ export const TOKEN = {
     env: 'INPUT_TOKEN'
 }
 
-export const PATH = {
-    name: 'path',
-    env: 'INPUT_PATH',
-    defaultValue: 'README.md'
-}
-
-export const BRANCH_NAME = {
-    name: 'branchName',
-    env: 'INPUT_BRANCHNAME',
-    defaultValue: 'preview/update-{timestamp}'
-}
-
-export const COMMIT_TITLE = {
-    name: 'commitTitle',
-    env: 'INPUT_COMMITTITLE',
-    defaultValue: 'docs(preview): Update preview'
-}
-
-export const COMMIT_BODY = {
-    name: 'commitBody',
-    env: 'INPUT_COMMITBODY',
-    defaultValue: ''
-}
-
-export const COMMIT_AUTHOR_NAME = {
-    name: 'commitAuthorName',
-    env: 'INPUT_COMMITAUTHORNAME',
-    defaultValue: 'github-actions'
-}
-
-export const COMMIT_AUTHOR_EMAIL = {
-    name: 'commitAuthorEmail',
-    env: 'INPUT_COMMITAUTHOREMAIL',
-    defaultValue: 'github-actions@github.com'
-}
-
-export const PR_TITLE = {
-    name: 'prTitle',
-    env: 'INPUT_PRTITLE',
-    defaultValue: 'Update preview'
-}
-
-export const PR_BODY = {
-    name: 'prBody',
-    env: 'INPUT_PRBODY',
-    defaultValue: ''
-}
-
-export const ASSIGNEES = {
-    name: 'assignees',
-    env: 'INPUT_ASSIGNEES',
-    defaultValue: ''
-}
-
-export const LABELS = {
-    name: 'labels',
-    env: 'INPUT_LABELS',
-    defaultValue: ''
+export const CONFIG_PATH = {
+    name: 'configPath',
+    env: 'INPUT_CONFIG_PATH',
+    defaultValue: '.github/preview-updater.yml'
 }
 
 export const parse = () => {
     const token = getInput(TOKEN.name, { required: true })
-    const path = getInput(PATH.name) || PATH.defaultValue
-    const branchName = (getInput(BRANCH_NAME.name) || BRANCH_NAME.defaultValue).replace('{timestamp}', Date.now().toString())
-
-    const commitTitle = getInput(COMMIT_TITLE.name) || COMMIT_TITLE.defaultValue
-    const commitBody = getInput(COMMIT_BODY.name) || COMMIT_BODY.defaultValue
-
-    const commitAuthorName = getInput(COMMIT_AUTHOR_NAME.name) || COMMIT_AUTHOR_NAME.defaultValue
-    const commitAuthorEmail = getInput(COMMIT_AUTHOR_EMAIL.name) || COMMIT_AUTHOR_EMAIL.defaultValue
-
-    const pullRequestTitle = getInput(PR_TITLE.name) || PR_TITLE.defaultValue
-    const pullRequestBody = getInput(PR_BODY.name) || PR_BODY.defaultValue
-
-    const assignees = splitCsv(getInput(ASSIGNEES.name) || ASSIGNEES.defaultValue)
-    const labels = splitCsv(getInput(LABELS.name) || LABELS.defaultValue)
+    const configPath = getInput(CONFIG_PATH.name) || CONFIG_PATH.defaultValue
 
     return {
         token,
-        path,
-        branchName,
-        commitTitle,
-        commitBody,
-        commitAuthorName,
-        commitAuthorEmail,
-        pullRequestTitle,
-        pullRequestBody,
-        assignees,
-        labels
+        configPath
     }
 }
-
-const splitCsv = (values: string) => {
-    return values
-        .split(',')
-        .map((value) => value.trim())
-        .filter((value) => value !== '')
-}