Merge pull request #133 from github/joshmgross/local-workflow-references

Support local workflow references
This commit is contained in:
Josh Gross
2023-02-07 16:11:14 -05:00
committed by GitHub
2 changed files with 31 additions and 8 deletions
+3 -1
View File
@@ -108,7 +108,9 @@ export function initConnection(connection: Connection) {
return undefined; return undefined;
}, },
fileProvider: getFileProvider(client, cache) fileProvider: getFileProvider(client, cache, repoContext?.workspaceUri, async path => {
return await connection.sendRequest("actions/readFile", {path});
})
}; };
const result = await validate(textDocument, config); const result = await validate(textDocument, config);
+28 -7
View File
@@ -2,22 +2,43 @@ import {File} from "@github/actions-workflow-parser/workflows/file";
import {FileProvider} from "@github/actions-workflow-parser/workflows/file-provider"; import {FileProvider} from "@github/actions-workflow-parser/workflows/file-provider";
import {fileIdentifier} from "@github/actions-workflow-parser/workflows/file-reference"; import {fileIdentifier} from "@github/actions-workflow-parser/workflows/file-reference";
import {Octokit} from "@octokit/rest"; import {Octokit} from "@octokit/rest";
import path from "path";
import {TTLCache} from "./utils/cache"; import {TTLCache} from "./utils/cache";
export function getFileProvider(client: Octokit | undefined, cache: TTLCache): FileProvider | undefined { export function getFileProvider(
if (!client) { client: Octokit | undefined,
cache: TTLCache,
workspace: string | undefined,
readFile: (path: string) => Promise<string>
): FileProvider | undefined {
if (!client && !workspace) {
return undefined; return undefined;
} }
return { return {
getFileContent: async (ref): Promise<File> => { getFileContent: async (ref): Promise<File> => {
if (!("repository" in ref)) { if ("repository" in ref) {
throw new Error("Only remote file references are supported right now"); if (!client) {
throw new Error("Remote file references are not supported with this configuration");
}
return await cache.get(`file-content-${fileIdentifier(ref)}`, undefined, () =>
fetchWorkflowFile(client, ref.owner, ref.repository, ref.path, ref.version)
);
} }
return await cache.get(`file-content-${fileIdentifier(ref)}`, undefined, () => if (!workspace) {
fetchWorkflowFile(client, ref.owner, ref.repository, ref.path, ref.version) throw new Error("Local file references are not supported with this configuration");
); }
const file = await readFile(path.join(workspace, ref.path));
if (!file) {
throw new Error(`File not found: ${ref.path}`);
}
return {
name: ref.path,
content: file
};
} }
}; };
} }