docker/actions-toolkit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #551 from crazy-max/git-pr-head-ref-optin

Browse Source 
context: opt-in pull request head ref
This commit is contained in:
CrazyMax
2025-01-15 11:38:38 +01:00
committed by GitHub
parent 9881e80bfd e02b7d7dab
commit e46ec802f8
2 changed files with 41 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
__tests__/context.test.ts
View File

@@ -14,7 +14,7 @@
* limitations under the License. * limitations under the License.
*/ */
import {describe, expect, jest, it, afterEach} from '@jest/globals'; import {describe, expect, jest, it, afterEach, beforeEach, test} from '@jest/globals';
import fs from 'fs'; import fs from 'fs';
import os from 'os'; import os from 'os';
import path from 'path'; import path from 'path';
@@ -44,6 +44,34 @@ describe('gitRef', () => {
}); });
}); });
describe('parseGitRef', () => {
const originalEnv = process.env;
beforeEach(() => {
jest.resetModules();
process.env = {
...originalEnv,
DOCKER_GIT_CONTEXT_PR_HEAD_REF: ''
};
});
afterEach(() => {
process.env = originalEnv;
});
// prettier-ignore
test.each([
['refs/heads/master', '860c1904a1ce19322e91ac35af1ab07466440c37', false, '860c1904a1ce19322e91ac35af1ab07466440c37'],
['master', '860c1904a1ce19322e91ac35af1ab07466440c37', false, '860c1904a1ce19322e91ac35af1ab07466440c37'],
['refs/pull/15/merge', '860c1904a1ce19322e91ac35af1ab07466440c37', false, 'refs/pull/15/merge'],
['refs/heads/master', '', false, 'refs/heads/master'],
['master', '', false, 'master'],
['refs/tags/v1.0.0', '', false, 'refs/tags/v1.0.0'],
['refs/pull/15/merge', '', false, 'refs/pull/15/merge'],
['refs/pull/15/merge', '', true, 'refs/pull/15/head'],
])('given %p and %p, should return %p', async (ref: string, sha: string, prHeadRef: boolean, expected: string) => {
process.env.DOCKER_DEFAULT_GIT_CONTEXT_PR_HEAD_REF = prHeadRef ? 'true' : '';
expect(Context.parseGitRef(ref, sha)).toEqual(expected);
});
});
describe('gitContext', () => { describe('gitContext', () => {
it('returns refs/heads/master', async () => { it('returns refs/heads/master', async () => {
expect(Context.gitContext()).toEqual('https://github.com/docker/actions-toolkit.git#refs/heads/master'); expect(Context.gitContext()).toEqual('https://github.com/docker/actions-toolkit.git#refs/heads/master');

20
src/context.ts
View File

@@ -39,16 +39,20 @@ export class Context {
} }
public static gitRef(): string { public static gitRef(): string {
let gitRef = github.context.ref; return Context.parseGitRef(github.context.ref, github.context.sha);
if (github.context.sha && gitRef && !gitRef.startsWith('refs/')) { }
gitRef = `refs/heads/${github.context.ref}`;
public static parseGitRef(ref: string, sha: string): string {
const setPullRequestHeadRef: boolean = !!(process.env.DOCKER_DEFAULT_GIT_CONTEXT_PR_HEAD_REF && process.env.DOCKER_DEFAULT_GIT_CONTEXT_PR_HEAD_REF === 'true');
if (sha && ref && !ref.startsWith('refs/')) {
ref = `refs/heads/${ref}`;
} }
if (github.context.sha && !gitRef.startsWith(`refs/pull/`)) { if (sha && !ref.startsWith(`refs/pull/`)) {
gitRef = github.context.sha; ref = sha;
} else if (gitRef.startsWith(`refs/pull/`)) { } else if (ref.startsWith(`refs/pull/`) && setPullRequestHeadRef) {
gitRef = gitRef.replace(/\/merge$/g, '/head'); ref = ref.replace(/\/merge$/g, '/head');
} }
return gitRef; return ref;
} }
public static gitContext(): string { public static gitContext(): string {