import * as fs from 'fs' import * as core from '@actions/core' import * as github from '@actions/github' import {Webhooks} from '@octokit/webhooks' import type {Octokit} from '@octokit/rest' import {Filter, FilterResults} from './filter' import {File, ChangeStatus} from './file' import * as git from './git' import shellEscape from './shell-escape' type ExportFormat = 'none' | 'json' | 'shell' async function run(): Promise { try { const workingDirectory = core.getInput('working-directory', {required: false}) if (workingDirectory) { process.chdir(workingDirectory) } const token = core.getInput('token', {required: false}) const base = core.getInput('base', {required: false}) const filtersInput = core.getInput('filters', {required: true}) const filtersYaml = isPathInput(filtersInput) ? getConfigFileContent(filtersInput) : filtersInput const listFiles = core.getInput('list-files', {required: false}).toLowerCase() || 'none' const initialFetchDepth = parseInt(core.getInput('initial-fetch-depth', {required: false})) || 10 if (!isExportFormat(listFiles)) { core.setFailed(`Input parameter 'list-files' is set to invalid value '${listFiles}'`) return } const filter = new Filter(filtersYaml) const files = await getChangedFiles(token, base, initialFetchDepth) const results = filter.match(files) exportResults(results, listFiles) } catch (error) { core.setFailed(error.message) } } function isPathInput(text: string): boolean { return !text.includes('\n') } function getConfigFileContent(configPath: string): string { if (!fs.existsSync(configPath)) { throw new Error(`Configuration file '${configPath}' not found`) } if (!fs.lstatSync(configPath).isFile()) { throw new Error(`'${configPath}' is not a file.`) } return fs.readFileSync(configPath, {encoding: 'utf8'}) } async function getChangedFiles(token: string, base: string, initialFetchDepth: number): Promise { if (github.context.eventName === 'pull_request' || github.context.eventName === 'pull_request_target') { const pr = github.context.payload.pull_request as Webhooks.WebhookPayloadPullRequestPullRequest if (token) { return await getChangedFilesFromApi(token, pr) } core.info('Github token is not available - changes will be detected from PRs merge commit') return await git.getChangesInLastCommit() } else { return getChangedFilesFromGit(base, initialFetchDepth) } } async function getChangedFilesFromGit(base: string, initialFetchDepth: number): Promise { const defaultRef = github.context.payload.repository?.default_branch const beforeSha = github.context.eventName === 'push' ? (github.context.payload as Webhooks.WebhookPayloadPush).before : null const pushRef = git.getShortName(github.context.ref) || (core.warning(`'ref' field is missing in PUSH event payload - using current branch, tag or commit SHA`), await git.getCurrentRef()) const baseRef = git.getShortName(base) || defaultRef if (!baseRef) { throw new Error( "This action requires 'base' input to be configured or 'repository.default_branch' to be set in the event payload" ) } const isBaseRefSha = git.isGitSha(baseRef) const isBaseSameAsPush = baseRef === pushRef // If base is commit SHA will do comparison against the referenced commit // Or If base references same branch it was pushed to, we will do comparison against the previously pushed commit if (isBaseRefSha || isBaseSameAsPush) { if (!isBaseRefSha && !beforeSha) { core.warning(`'before' field is missing in PUSH event payload - changes will be detected from last commit`) return await git.getChangesInLastCommit() } const baseSha = isBaseRefSha ? baseRef : beforeSha // If there is no previously pushed commit, // we will do comparison against the default branch or return all as added if (baseSha === git.NULL_SHA) { if (defaultRef && baseRef !== defaultRef) { core.info(`First push of a branch detected - changes will be detected against the default branch ${defaultRef}`) return await git.getChangesSinceMergeBase(defaultRef, initialFetchDepth) } else { core.info('Initial push detected - all files will be listed as added') return await git.listAllFilesAsAdded() } } core.info(`Changes will be detected against commit (${baseSha})`) return await git.getChanges(baseSha) } // Changes introduced by current branch against the base branch core.info(`Changes will be detected against the branch ${baseRef}`) return await git.getChangesSinceMergeBase(baseRef, initialFetchDepth) } // Uses github REST api to get list of files changed in PR async function getChangedFilesFromApi( token: string, pullRequest: Webhooks.WebhookPayloadPullRequestPullRequest ): Promise { core.info(`Fetching list of changed files for PR#${pullRequest.number} from Github API`) const client = new github.GitHub(token) const pageSize = 100 const files: File[] = [] let response: Octokit.Response let page = 0 do { response = await client.pulls.listFiles({ owner: github.context.repo.owner, repo: github.context.repo.repo, pull_number: pullRequest.number, page, per_page: pageSize }) for (const row of response.data) { // There's no obvious use-case for detection of renames // Therefore we treat it as if rename detection in git diff was turned off. // Rename is replaced by delete of original filename and add of new filename if (row.status === ChangeStatus.Renamed) { files.push({ filename: row.filename, status: ChangeStatus.Added }) files.push({ // 'previous_filename' for some unknown reason isn't in the type definition or documentation filename: (row).previous_filename as string, status: ChangeStatus.Deleted }) } else { files.push({ filename: row.filename, status: row.status as ChangeStatus }) } } page++ } while (response?.data?.length > 0) return files } function exportResults(results: FilterResults, format: ExportFormat): void { core.info('Results:') for (const [key, files] of Object.entries(results)) { const value = files.length > 0 core.startGroup(`Filter ${key} = ${value}`) if (files.length > 0) { core.info('Matching files:') for (const file of files) { core.info(`${file.filename} [${file.status}]`) } } else { core.info('Matching files: none') } core.setOutput(key, value) if (format !== 'none') { const filesValue = serializeExport(files, format) core.setOutput(`${key}_files`, filesValue) } } core.endGroup() } function serializeExport(files: File[], format: ExportFormat): string { const fileNames = files.map(file => file.filename) switch (format) { case 'json': return JSON.stringify(fileNames) case 'shell': return fileNames.map(shellEscape).join(' ') default: return '' } } function isExportFormat(value: string): value is ExportFormat { return value === 'none' || value === 'shell' || value === 'json' } run()