Merge pull request #54

Add support for fetching and merging remote configuration files

Author: andrey-helldar

README.md

@@ -67,6 +67,12 @@ The action is setting the following outputs:
 
 ## Configuration
 
+> [!TIP]
+> 
+> Support for working with a global settings file at the organization level (the `.github` repository).
+> 
+> For example, `https://github.com/<repo>/.github/blob/main/.github/preview-updater.yml`.
+
 Create `.github/preview-updater.yml` (or provide your own path via `configPath`).
 All fields are optional—omitted ones fall back to defaults.
 

src/main.ts

@@ -16,7 +16,7 @@ const previewUpdater = async () => {
     const { token, configPath } = parse();
 
     // Load Config
-    const config: Config = readConfig(
+    const config: Config = await readConfig(
         <Config>{
             directory: cwd(),
 

src/utils/config.ts

@@ -1,16 +1,51 @@
 import { type Config, defaultConfig } from "../types/config";
 import * as yaml from "js-yaml";
-import { readFile } from "./filesystem";
+import { readFile, readRemoteFile } from "./filesystem";
 import { merge } from "./merge";
+import { info } from "@actions/core";
+import * as url from "node:url";
 
-export const readConfig = (config: Config, userConfigPath: string): Config => {
+export const readConfig = async (
+    config: Config,
+    userConfigPath: string,
+): Promise<Config> => {
     const content: string = readFile(config, userConfigPath);
+    const remoteConfig: Config = await readRemoteConfig(
+        config.repository?.owner,
+        userConfigPath,
+    );
 
     if (content === "") {
-        return <Config>merge(defaultConfig, config);
+        return <Config>merge(defaultConfig, remoteConfig, config);
     }
 
     const userConfig = <Config>yaml.load(content);
 
-    return <Config>merge(defaultConfig, userConfig, config);
+    return <Config>merge(defaultConfig, remoteConfig, userConfig, config);
+};
+
+export const readRemoteConfig = async (
+    owner: string | undefined,
+    filename: string,
+): Promise<Config> => {
+    try {
+        if (owner === undefined) {
+            return <Config>{};
+        }
+
+        const url = `https://raw.githubusercontent.com/${owner}/.github/refs/heads/main/${filename}`;
+
+        const data: string = await readRemoteFile(url);
+
+        if (data === "") {
+            return <Config>{};
+        }
+
+        return <Config>yaml.load(data);
+    } catch (error) {
+        // @ts-expect-error
+        info(`Failed to fetch remote config from ${url}: ${error.message}`);
+
+        return <Config>{};
+    }
 };

src/utils/filesystem.ts

@@ -1,5 +1,6 @@
 import * as fs from "node:fs";
 import type { Config } from "../types/config";
+import { info } from "@actions/core";
 
 export const cwd = (): string => {
     const path = process.env.GITHUB_WORKSPACE;
@@ -17,6 +18,18 @@ const filePath = (config: Config, filename: string): string =>
 export const fileExists = (config: Config, filename: string): boolean =>
     fs.existsSync(filePath(config, filename));
 
+export const readRemoteFile = async (url: string): Promise<string> => {
+    const response: Response = await fetch(url);
+
+    if (!response.ok) {
+        info(`Failed to fetch ${url} with status code ${response.status}`);
+
+        return "";
+    }
+
+    return response.text();
+};
+
 export const readFile = (config: Config, filename: string): string => {
     if (!fs.existsSync(filePath(config, filename))) {
         return "";

tests/unit/filesystem.test.ts

@@ -3,8 +3,11 @@ import { type Config, defaultConfig } from "../../src/types/config";
 import { CONFIG_PATH } from "../../src/utils/inputs";
 import { readConfig } from "../../src/utils/config";
 
-test("read config", () => {
-    const data: Config = readConfig(rawTestConfig, CONFIG_PATH.defaultValue);
+test("read config", async () => {
+    const data: Config = await readConfig(
+        rawTestConfig,
+        CONFIG_PATH.defaultValue,
+    );
 
     expect(data.directory).toBe(process.cwd());
 
@@ -26,8 +29,8 @@ test("read config", () => {
     expect(data.image.parameters.icon).toBe("photograph");
 });
 
-test("custom config", () => {
-    const data: Config = readConfig(
+test("custom config", async () => {
+    const data: Config = await readConfig(
         <Config>{
             directory: process.cwd(),
         },