mirror of
https://github.com/actions/checkout.git
synced 2026-05-12 21:13:34 +00:00
Compare commits
No commits in common. "main" and "v6.0.1" have entirely different histories.
11
.github/workflows/test.yml
vendored
11
.github/workflows/test.yml
vendored
|
|
@ -87,17 +87,6 @@ jobs:
|
||||||
- name: Verify fetch filter
|
- name: Verify fetch filter
|
||||||
run: __test__/verify-fetch-filter.sh
|
run: __test__/verify-fetch-filter.sh
|
||||||
|
|
||||||
# Fetch tags
|
|
||||||
- name: Checkout with fetch-tags
|
|
||||||
uses: ./
|
|
||||||
with:
|
|
||||||
ref: test-data/v2/basic
|
|
||||||
path: fetch-tags-test
|
|
||||||
fetch-tags: true
|
|
||||||
- name: Verify fetch-tags
|
|
||||||
shell: bash
|
|
||||||
run: __test__/verify-fetch-tags.sh
|
|
||||||
|
|
||||||
# Sparse checkout
|
# Sparse checkout
|
||||||
- name: Sparse checkout
|
- name: Sparse checkout
|
||||||
uses: ./
|
uses: ./
|
||||||
|
|
|
||||||
|
|
@ -1,11 +1,5 @@
|
||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
## v6.0.2
|
|
||||||
* Fix tag handling: preserve annotations and explicit fetch-tags by @ericsciple in https://github.com/actions/checkout/pull/2356
|
|
||||||
|
|
||||||
## v6.0.1
|
|
||||||
* Add worktree support for persist-credentials includeIf by @ericsciple in https://github.com/actions/checkout/pull/2327
|
|
||||||
|
|
||||||
## v6.0.0
|
## v6.0.0
|
||||||
* Persist creds to a separate file by @ericsciple in https://github.com/actions/checkout/pull/2286
|
* Persist creds to a separate file by @ericsciple in https://github.com/actions/checkout/pull/2286
|
||||||
* Update README to include Node.js 24 support details and requirements by @salmanmkc in https://github.com/actions/checkout/pull/2248
|
* Update README to include Node.js 24 support details and requirements by @salmanmkc in https://github.com/actions/checkout/pull/2248
|
||||||
|
|
|
||||||
|
|
@ -108,7 +108,7 @@ describe('Test fetchDepth and fetchTags options', () => {
|
||||||
jest.restoreAllMocks()
|
jest.restoreAllMocks()
|
||||||
})
|
})
|
||||||
|
|
||||||
it('should call execGit with the correct arguments when fetchDepth is 0', async () => {
|
it('should call execGit with the correct arguments when fetchDepth is 0 and fetchTags is true', async () => {
|
||||||
jest.spyOn(exec, 'exec').mockImplementation(mockExec)
|
jest.spyOn(exec, 'exec').mockImplementation(mockExec)
|
||||||
const workingDirectory = 'test'
|
const workingDirectory = 'test'
|
||||||
const lfs = false
|
const lfs = false
|
||||||
|
|
@ -122,7 +122,45 @@ describe('Test fetchDepth and fetchTags options', () => {
|
||||||
const refSpec = ['refspec1', 'refspec2']
|
const refSpec = ['refspec1', 'refspec2']
|
||||||
const options = {
|
const options = {
|
||||||
filter: 'filterValue',
|
filter: 'filterValue',
|
||||||
fetchDepth: 0
|
fetchDepth: 0,
|
||||||
|
fetchTags: true
|
||||||
|
}
|
||||||
|
|
||||||
|
await git.fetch(refSpec, options)
|
||||||
|
|
||||||
|
expect(mockExec).toHaveBeenCalledWith(
|
||||||
|
expect.any(String),
|
||||||
|
[
|
||||||
|
'-c',
|
||||||
|
'protocol.version=2',
|
||||||
|
'fetch',
|
||||||
|
'--prune',
|
||||||
|
'--no-recurse-submodules',
|
||||||
|
'--filter=filterValue',
|
||||||
|
'origin',
|
||||||
|
'refspec1',
|
||||||
|
'refspec2'
|
||||||
|
],
|
||||||
|
expect.any(Object)
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should call execGit with the correct arguments when fetchDepth is 0 and fetchTags is false', async () => {
|
||||||
|
jest.spyOn(exec, 'exec').mockImplementation(mockExec)
|
||||||
|
|
||||||
|
const workingDirectory = 'test'
|
||||||
|
const lfs = false
|
||||||
|
const doSparseCheckout = false
|
||||||
|
git = await commandManager.createCommandManager(
|
||||||
|
workingDirectory,
|
||||||
|
lfs,
|
||||||
|
doSparseCheckout
|
||||||
|
)
|
||||||
|
const refSpec = ['refspec1', 'refspec2']
|
||||||
|
const options = {
|
||||||
|
filter: 'filterValue',
|
||||||
|
fetchDepth: 0,
|
||||||
|
fetchTags: false
|
||||||
}
|
}
|
||||||
|
|
||||||
await git.fetch(refSpec, options)
|
await git.fetch(refSpec, options)
|
||||||
|
|
@ -145,45 +183,7 @@ describe('Test fetchDepth and fetchTags options', () => {
|
||||||
)
|
)
|
||||||
})
|
})
|
||||||
|
|
||||||
it('should call execGit with the correct arguments when fetchDepth is 0 and refSpec includes tags', async () => {
|
it('should call execGit with the correct arguments when fetchDepth is 1 and fetchTags is false', async () => {
|
||||||
jest.spyOn(exec, 'exec').mockImplementation(mockExec)
|
|
||||||
|
|
||||||
const workingDirectory = 'test'
|
|
||||||
const lfs = false
|
|
||||||
const doSparseCheckout = false
|
|
||||||
git = await commandManager.createCommandManager(
|
|
||||||
workingDirectory,
|
|
||||||
lfs,
|
|
||||||
doSparseCheckout
|
|
||||||
)
|
|
||||||
const refSpec = ['refspec1', 'refspec2', '+refs/tags/*:refs/tags/*']
|
|
||||||
const options = {
|
|
||||||
filter: 'filterValue',
|
|
||||||
fetchDepth: 0
|
|
||||||
}
|
|
||||||
|
|
||||||
await git.fetch(refSpec, options)
|
|
||||||
|
|
||||||
expect(mockExec).toHaveBeenCalledWith(
|
|
||||||
expect.any(String),
|
|
||||||
[
|
|
||||||
'-c',
|
|
||||||
'protocol.version=2',
|
|
||||||
'fetch',
|
|
||||||
'--no-tags',
|
|
||||||
'--prune',
|
|
||||||
'--no-recurse-submodules',
|
|
||||||
'--filter=filterValue',
|
|
||||||
'origin',
|
|
||||||
'refspec1',
|
|
||||||
'refspec2',
|
|
||||||
'+refs/tags/*:refs/tags/*'
|
|
||||||
],
|
|
||||||
expect.any(Object)
|
|
||||||
)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should call execGit with the correct arguments when fetchDepth is 1', async () => {
|
|
||||||
jest.spyOn(exec, 'exec').mockImplementation(mockExec)
|
jest.spyOn(exec, 'exec').mockImplementation(mockExec)
|
||||||
|
|
||||||
const workingDirectory = 'test'
|
const workingDirectory = 'test'
|
||||||
|
|
@ -197,7 +197,8 @@ describe('Test fetchDepth and fetchTags options', () => {
|
||||||
const refSpec = ['refspec1', 'refspec2']
|
const refSpec = ['refspec1', 'refspec2']
|
||||||
const options = {
|
const options = {
|
||||||
filter: 'filterValue',
|
filter: 'filterValue',
|
||||||
fetchDepth: 1
|
fetchDepth: 1,
|
||||||
|
fetchTags: false
|
||||||
}
|
}
|
||||||
|
|
||||||
await git.fetch(refSpec, options)
|
await git.fetch(refSpec, options)
|
||||||
|
|
@ -221,7 +222,7 @@ describe('Test fetchDepth and fetchTags options', () => {
|
||||||
)
|
)
|
||||||
})
|
})
|
||||||
|
|
||||||
it('should call execGit with the correct arguments when fetchDepth is 1 and refSpec includes tags', async () => {
|
it('should call execGit with the correct arguments when fetchDepth is 1 and fetchTags is true', async () => {
|
||||||
jest.spyOn(exec, 'exec').mockImplementation(mockExec)
|
jest.spyOn(exec, 'exec').mockImplementation(mockExec)
|
||||||
|
|
||||||
const workingDirectory = 'test'
|
const workingDirectory = 'test'
|
||||||
|
|
@ -232,10 +233,11 @@ describe('Test fetchDepth and fetchTags options', () => {
|
||||||
lfs,
|
lfs,
|
||||||
doSparseCheckout
|
doSparseCheckout
|
||||||
)
|
)
|
||||||
const refSpec = ['refspec1', 'refspec2', '+refs/tags/*:refs/tags/*']
|
const refSpec = ['refspec1', 'refspec2']
|
||||||
const options = {
|
const options = {
|
||||||
filter: 'filterValue',
|
filter: 'filterValue',
|
||||||
fetchDepth: 1
|
fetchDepth: 1,
|
||||||
|
fetchTags: true
|
||||||
}
|
}
|
||||||
|
|
||||||
await git.fetch(refSpec, options)
|
await git.fetch(refSpec, options)
|
||||||
|
|
@ -246,15 +248,13 @@ describe('Test fetchDepth and fetchTags options', () => {
|
||||||
'-c',
|
'-c',
|
||||||
'protocol.version=2',
|
'protocol.version=2',
|
||||||
'fetch',
|
'fetch',
|
||||||
'--no-tags',
|
|
||||||
'--prune',
|
'--prune',
|
||||||
'--no-recurse-submodules',
|
'--no-recurse-submodules',
|
||||||
'--filter=filterValue',
|
'--filter=filterValue',
|
||||||
'--depth=1',
|
'--depth=1',
|
||||||
'origin',
|
'origin',
|
||||||
'refspec1',
|
'refspec1',
|
||||||
'refspec2',
|
'refspec2'
|
||||||
'+refs/tags/*:refs/tags/*'
|
|
||||||
],
|
],
|
||||||
expect.any(Object)
|
expect.any(Object)
|
||||||
)
|
)
|
||||||
|
|
@ -338,7 +338,7 @@ describe('Test fetchDepth and fetchTags options', () => {
|
||||||
)
|
)
|
||||||
})
|
})
|
||||||
|
|
||||||
it('should call execGit with the correct arguments when showProgress is true and refSpec includes tags', async () => {
|
it('should call execGit with the correct arguments when fetchTags is true and showProgress is true', async () => {
|
||||||
jest.spyOn(exec, 'exec').mockImplementation(mockExec)
|
jest.spyOn(exec, 'exec').mockImplementation(mockExec)
|
||||||
|
|
||||||
const workingDirectory = 'test'
|
const workingDirectory = 'test'
|
||||||
|
|
@ -349,9 +349,10 @@ describe('Test fetchDepth and fetchTags options', () => {
|
||||||
lfs,
|
lfs,
|
||||||
doSparseCheckout
|
doSparseCheckout
|
||||||
)
|
)
|
||||||
const refSpec = ['refspec1', 'refspec2', '+refs/tags/*:refs/tags/*']
|
const refSpec = ['refspec1', 'refspec2']
|
||||||
const options = {
|
const options = {
|
||||||
filter: 'filterValue',
|
filter: 'filterValue',
|
||||||
|
fetchTags: true,
|
||||||
showProgress: true
|
showProgress: true
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -363,134 +364,15 @@ describe('Test fetchDepth and fetchTags options', () => {
|
||||||
'-c',
|
'-c',
|
||||||
'protocol.version=2',
|
'protocol.version=2',
|
||||||
'fetch',
|
'fetch',
|
||||||
'--no-tags',
|
|
||||||
'--prune',
|
'--prune',
|
||||||
'--no-recurse-submodules',
|
'--no-recurse-submodules',
|
||||||
'--progress',
|
'--progress',
|
||||||
'--filter=filterValue',
|
'--filter=filterValue',
|
||||||
'origin',
|
'origin',
|
||||||
'refspec1',
|
'refspec1',
|
||||||
'refspec2',
|
'refspec2'
|
||||||
'+refs/tags/*:refs/tags/*'
|
|
||||||
],
|
],
|
||||||
expect.any(Object)
|
expect.any(Object)
|
||||||
)
|
)
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
|
||||||
describe('git user-agent with orchestration ID', () => {
|
|
||||||
beforeEach(async () => {
|
|
||||||
jest.spyOn(fshelper, 'fileExistsSync').mockImplementation(jest.fn())
|
|
||||||
jest.spyOn(fshelper, 'directoryExistsSync').mockImplementation(jest.fn())
|
|
||||||
})
|
|
||||||
|
|
||||||
afterEach(() => {
|
|
||||||
jest.restoreAllMocks()
|
|
||||||
// Clean up environment variable to prevent test pollution
|
|
||||||
delete process.env['ACTIONS_ORCHESTRATION_ID']
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should include orchestration ID in user-agent when ACTIONS_ORCHESTRATION_ID is set', async () => {
|
|
||||||
const orchId = 'test-orch-id-12345'
|
|
||||||
process.env['ACTIONS_ORCHESTRATION_ID'] = orchId
|
|
||||||
|
|
||||||
let capturedEnv: any = null
|
|
||||||
mockExec.mockImplementation((path, args, options) => {
|
|
||||||
if (args.includes('version')) {
|
|
||||||
options.listeners.stdout(Buffer.from('2.18'))
|
|
||||||
}
|
|
||||||
// Capture env on any command
|
|
||||||
capturedEnv = options.env
|
|
||||||
return 0
|
|
||||||
})
|
|
||||||
jest.spyOn(exec, 'exec').mockImplementation(mockExec)
|
|
||||||
|
|
||||||
const workingDirectory = 'test'
|
|
||||||
const lfs = false
|
|
||||||
const doSparseCheckout = false
|
|
||||||
git = await commandManager.createCommandManager(
|
|
||||||
workingDirectory,
|
|
||||||
lfs,
|
|
||||||
doSparseCheckout
|
|
||||||
)
|
|
||||||
|
|
||||||
// Call a git command to trigger env capture after user-agent is set
|
|
||||||
await git.init()
|
|
||||||
|
|
||||||
// Verify the user agent includes the orchestration ID
|
|
||||||
expect(git).toBeDefined()
|
|
||||||
expect(capturedEnv).toBeDefined()
|
|
||||||
expect(capturedEnv['GIT_HTTP_USER_AGENT']).toBe(
|
|
||||||
`git/2.18 (github-actions-checkout) actions_orchestration_id/${orchId}`
|
|
||||||
)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should sanitize invalid characters in orchestration ID', async () => {
|
|
||||||
const orchId = 'test (with) special/chars'
|
|
||||||
process.env['ACTIONS_ORCHESTRATION_ID'] = orchId
|
|
||||||
|
|
||||||
let capturedEnv: any = null
|
|
||||||
mockExec.mockImplementation((path, args, options) => {
|
|
||||||
if (args.includes('version')) {
|
|
||||||
options.listeners.stdout(Buffer.from('2.18'))
|
|
||||||
}
|
|
||||||
// Capture env on any command
|
|
||||||
capturedEnv = options.env
|
|
||||||
return 0
|
|
||||||
})
|
|
||||||
jest.spyOn(exec, 'exec').mockImplementation(mockExec)
|
|
||||||
|
|
||||||
const workingDirectory = 'test'
|
|
||||||
const lfs = false
|
|
||||||
const doSparseCheckout = false
|
|
||||||
git = await commandManager.createCommandManager(
|
|
||||||
workingDirectory,
|
|
||||||
lfs,
|
|
||||||
doSparseCheckout
|
|
||||||
)
|
|
||||||
|
|
||||||
// Call a git command to trigger env capture after user-agent is set
|
|
||||||
await git.init()
|
|
||||||
|
|
||||||
// Verify the user agent has sanitized orchestration ID (spaces, parentheses, slash replaced)
|
|
||||||
expect(git).toBeDefined()
|
|
||||||
expect(capturedEnv).toBeDefined()
|
|
||||||
expect(capturedEnv['GIT_HTTP_USER_AGENT']).toBe(
|
|
||||||
'git/2.18 (github-actions-checkout) actions_orchestration_id/test__with__special_chars'
|
|
||||||
)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should not modify user-agent when ACTIONS_ORCHESTRATION_ID is not set', async () => {
|
|
||||||
delete process.env['ACTIONS_ORCHESTRATION_ID']
|
|
||||||
|
|
||||||
let capturedEnv: any = null
|
|
||||||
mockExec.mockImplementation((path, args, options) => {
|
|
||||||
if (args.includes('version')) {
|
|
||||||
options.listeners.stdout(Buffer.from('2.18'))
|
|
||||||
}
|
|
||||||
// Capture env on any command
|
|
||||||
capturedEnv = options.env
|
|
||||||
return 0
|
|
||||||
})
|
|
||||||
jest.spyOn(exec, 'exec').mockImplementation(mockExec)
|
|
||||||
|
|
||||||
const workingDirectory = 'test'
|
|
||||||
const lfs = false
|
|
||||||
const doSparseCheckout = false
|
|
||||||
git = await commandManager.createCommandManager(
|
|
||||||
workingDirectory,
|
|
||||||
lfs,
|
|
||||||
doSparseCheckout
|
|
||||||
)
|
|
||||||
|
|
||||||
// Call a git command to trigger env capture after user-agent is set
|
|
||||||
await git.init()
|
|
||||||
|
|
||||||
// Verify the user agent does NOT contain orchestration ID
|
|
||||||
expect(git).toBeDefined()
|
|
||||||
expect(capturedEnv).toBeDefined()
|
|
||||||
expect(capturedEnv['GIT_HTTP_USER_AGENT']).toBe(
|
|
||||||
'git/2.18 (github-actions-checkout)'
|
|
||||||
)
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
|
||||||
|
|
@ -133,16 +133,6 @@ describe('input-helper tests', () => {
|
||||||
expect(settings.commit).toBe('1111111111222222222233333333334444444444')
|
expect(settings.commit).toBe('1111111111222222222233333333334444444444')
|
||||||
})
|
})
|
||||||
|
|
||||||
it('sets ref to empty when explicit sha-256', async () => {
|
|
||||||
inputs.ref =
|
|
||||||
'1111111111222222222233333333334444444444555555555566666666667777'
|
|
||||||
const settings: IGitSourceSettings = await inputHelper.getInputs()
|
|
||||||
expect(settings.ref).toBeFalsy()
|
|
||||||
expect(settings.commit).toBe(
|
|
||||||
'1111111111222222222233333333334444444444555555555566666666667777'
|
|
||||||
)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('sets sha to empty when explicit ref', async () => {
|
it('sets sha to empty when explicit ref', async () => {
|
||||||
inputs.ref = 'refs/heads/some-other-ref'
|
inputs.ref = 'refs/heads/some-other-ref'
|
||||||
const settings: IGitSourceSettings = await inputHelper.getInputs()
|
const settings: IGitSourceSettings = await inputHelper.getInputs()
|
||||||
|
|
|
||||||
|
|
@ -1,12 +1,8 @@
|
||||||
import * as assert from 'assert'
|
import * as assert from 'assert'
|
||||||
import * as core from '@actions/core'
|
|
||||||
import * as github from '@actions/github'
|
|
||||||
import * as refHelper from '../lib/ref-helper'
|
import * as refHelper from '../lib/ref-helper'
|
||||||
import {IGitCommandManager} from '../lib/git-command-manager'
|
import {IGitCommandManager} from '../lib/git-command-manager'
|
||||||
|
|
||||||
const commit = '1234567890123456789012345678901234567890'
|
const commit = '1234567890123456789012345678901234567890'
|
||||||
const sha256Commit =
|
|
||||||
'1234567890123456789012345678901234567890123456789012345678901234'
|
|
||||||
let git: IGitCommandManager
|
let git: IGitCommandManager
|
||||||
|
|
||||||
describe('ref-helper tests', () => {
|
describe('ref-helper tests', () => {
|
||||||
|
|
@ -41,12 +37,6 @@ describe('ref-helper tests', () => {
|
||||||
expect(checkoutInfo.startPoint).toBeFalsy()
|
expect(checkoutInfo.startPoint).toBeFalsy()
|
||||||
})
|
})
|
||||||
|
|
||||||
it('getCheckoutInfo sha-256 only', async () => {
|
|
||||||
const checkoutInfo = await refHelper.getCheckoutInfo(git, '', sha256Commit)
|
|
||||||
expect(checkoutInfo.ref).toBe(sha256Commit)
|
|
||||||
expect(checkoutInfo.startPoint).toBeFalsy()
|
|
||||||
})
|
|
||||||
|
|
||||||
it('getCheckoutInfo refs/heads/', async () => {
|
it('getCheckoutInfo refs/heads/', async () => {
|
||||||
const checkoutInfo = await refHelper.getCheckoutInfo(
|
const checkoutInfo = await refHelper.getCheckoutInfo(
|
||||||
git,
|
git,
|
||||||
|
|
@ -162,22 +152,7 @@ describe('ref-helper tests', () => {
|
||||||
it('getRefSpec sha + refs/tags/', async () => {
|
it('getRefSpec sha + refs/tags/', async () => {
|
||||||
const refSpec = refHelper.getRefSpec('refs/tags/my-tag', commit)
|
const refSpec = refHelper.getRefSpec('refs/tags/my-tag', commit)
|
||||||
expect(refSpec.length).toBe(1)
|
expect(refSpec.length).toBe(1)
|
||||||
expect(refSpec[0]).toBe(`+refs/tags/my-tag:refs/tags/my-tag`)
|
expect(refSpec[0]).toBe(`+${commit}:refs/tags/my-tag`)
|
||||||
})
|
|
||||||
|
|
||||||
it('getRefSpec sha + refs/tags/ with fetchTags', async () => {
|
|
||||||
// When fetchTags is true, only include tags wildcard (specific tag is redundant)
|
|
||||||
const refSpec = refHelper.getRefSpec('refs/tags/my-tag', commit, true)
|
|
||||||
expect(refSpec.length).toBe(1)
|
|
||||||
expect(refSpec[0]).toBe('+refs/tags/*:refs/tags/*')
|
|
||||||
})
|
|
||||||
|
|
||||||
it('getRefSpec sha + refs/heads/ with fetchTags', async () => {
|
|
||||||
// When fetchTags is true, include both the branch refspec and tags wildcard
|
|
||||||
const refSpec = refHelper.getRefSpec('refs/heads/my/branch', commit, true)
|
|
||||||
expect(refSpec.length).toBe(2)
|
|
||||||
expect(refSpec[0]).toBe('+refs/tags/*:refs/tags/*')
|
|
||||||
expect(refSpec[1]).toBe(`+${commit}:refs/remotes/origin/my/branch`)
|
|
||||||
})
|
})
|
||||||
|
|
||||||
it('getRefSpec sha only', async () => {
|
it('getRefSpec sha only', async () => {
|
||||||
|
|
@ -193,14 +168,6 @@ describe('ref-helper tests', () => {
|
||||||
expect(refSpec[1]).toBe('+refs/tags/my-ref*:refs/tags/my-ref*')
|
expect(refSpec[1]).toBe('+refs/tags/my-ref*:refs/tags/my-ref*')
|
||||||
})
|
})
|
||||||
|
|
||||||
it('getRefSpec unqualified ref only with fetchTags', async () => {
|
|
||||||
// When fetchTags is true, skip specific tag pattern since wildcard covers all
|
|
||||||
const refSpec = refHelper.getRefSpec('my-ref', '', true)
|
|
||||||
expect(refSpec.length).toBe(2)
|
|
||||||
expect(refSpec[0]).toBe('+refs/tags/*:refs/tags/*')
|
|
||||||
expect(refSpec[1]).toBe('+refs/heads/my-ref*:refs/remotes/origin/my-ref*')
|
|
||||||
})
|
|
||||||
|
|
||||||
it('getRefSpec refs/heads/ only', async () => {
|
it('getRefSpec refs/heads/ only', async () => {
|
||||||
const refSpec = refHelper.getRefSpec('refs/heads/my/branch', '')
|
const refSpec = refHelper.getRefSpec('refs/heads/my/branch', '')
|
||||||
expect(refSpec.length).toBe(1)
|
expect(refSpec.length).toBe(1)
|
||||||
|
|
@ -220,159 +187,4 @@ describe('ref-helper tests', () => {
|
||||||
expect(refSpec.length).toBe(1)
|
expect(refSpec.length).toBe(1)
|
||||||
expect(refSpec[0]).toBe('+refs/tags/my-tag:refs/tags/my-tag')
|
expect(refSpec[0]).toBe('+refs/tags/my-tag:refs/tags/my-tag')
|
||||||
})
|
})
|
||||||
|
|
||||||
it('getRefSpec refs/tags/ only with fetchTags', async () => {
|
|
||||||
// When fetchTags is true, only include tags wildcard (specific tag is redundant)
|
|
||||||
const refSpec = refHelper.getRefSpec('refs/tags/my-tag', '', true)
|
|
||||||
expect(refSpec.length).toBe(1)
|
|
||||||
expect(refSpec[0]).toBe('+refs/tags/*:refs/tags/*')
|
|
||||||
})
|
|
||||||
|
|
||||||
it('getRefSpec refs/heads/ only with fetchTags', async () => {
|
|
||||||
// When fetchTags is true, include both the branch refspec and tags wildcard
|
|
||||||
const refSpec = refHelper.getRefSpec('refs/heads/my/branch', '', true)
|
|
||||||
expect(refSpec.length).toBe(2)
|
|
||||||
expect(refSpec[0]).toBe('+refs/tags/*:refs/tags/*')
|
|
||||||
expect(refSpec[1]).toBe(
|
|
||||||
'+refs/heads/my/branch:refs/remotes/origin/my/branch'
|
|
||||||
)
|
|
||||||
})
|
|
||||||
|
|
||||||
describe('checkCommitInfo', () => {
|
|
||||||
const repositoryOwner = 'some-owner'
|
|
||||||
const repositoryName = 'some-repo'
|
|
||||||
const ref = 'refs/pull/123/merge'
|
|
||||||
const sha1Head = '1111111111222222222233333333334444444444'
|
|
||||||
const sha1Base = 'aaaaaaaaaabbbbbbbbbbccccccccccdddddddddd'
|
|
||||||
const sha256Head =
|
|
||||||
'1111111111222222222233333333334444444444555555555566666666667777'
|
|
||||||
const sha256Base =
|
|
||||||
'aaaaaaaaaabbbbbbbbbbccccccccccddddddddddeeeeeeeeeeffffffffff0000'
|
|
||||||
let debugSpy: jest.SpyInstance
|
|
||||||
let getOctokitSpy: jest.SpyInstance
|
|
||||||
let repoGetSpy: jest.Mock
|
|
||||||
let originalEventName: string
|
|
||||||
let originalPayload: unknown
|
|
||||||
let originalRef: string
|
|
||||||
let originalSha: string
|
|
||||||
|
|
||||||
function setPullRequestContext(
|
|
||||||
expectedHeadSha: string,
|
|
||||||
expectedBaseSha: string,
|
|
||||||
mergeCommit: string
|
|
||||||
): void {
|
|
||||||
;(github.context as any).eventName = 'pull_request'
|
|
||||||
github.context.ref = ref
|
|
||||||
github.context.sha = mergeCommit
|
|
||||||
;(github.context as any).payload = {
|
|
||||||
action: 'synchronize',
|
|
||||||
after: expectedHeadSha,
|
|
||||||
number: 123,
|
|
||||||
pull_request: {
|
|
||||||
base: {
|
|
||||||
sha: expectedBaseSha
|
|
||||||
}
|
|
||||||
},
|
|
||||||
repository: {
|
|
||||||
private: false
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
beforeEach(() => {
|
|
||||||
originalEventName = github.context.eventName
|
|
||||||
originalPayload = github.context.payload
|
|
||||||
originalRef = github.context.ref
|
|
||||||
originalSha = github.context.sha
|
|
||||||
|
|
||||||
jest.spyOn(github.context, 'repo', 'get').mockReturnValue({
|
|
||||||
owner: repositoryOwner,
|
|
||||||
repo: repositoryName
|
|
||||||
})
|
|
||||||
debugSpy = jest.spyOn(core, 'debug').mockImplementation(jest.fn())
|
|
||||||
repoGetSpy = jest.fn(async () => ({}))
|
|
||||||
getOctokitSpy = jest.spyOn(github, 'getOctokit').mockReturnValue({
|
|
||||||
rest: {
|
|
||||||
repos: {
|
|
||||||
get: repoGetSpy
|
|
||||||
}
|
|
||||||
}
|
|
||||||
} as any)
|
|
||||||
})
|
|
||||||
|
|
||||||
afterEach(() => {
|
|
||||||
;(github.context as any).eventName = originalEventName
|
|
||||||
;(github.context as any).payload = originalPayload
|
|
||||||
github.context.ref = originalRef
|
|
||||||
github.context.sha = originalSha
|
|
||||||
jest.restoreAllMocks()
|
|
||||||
})
|
|
||||||
|
|
||||||
it('returns early for SHA-1 merge commit', async () => {
|
|
||||||
setPullRequestContext(sha1Head, sha1Base, commit)
|
|
||||||
|
|
||||||
await refHelper.checkCommitInfo(
|
|
||||||
'token',
|
|
||||||
`Merge ${sha1Head} into ${sha1Base}`,
|
|
||||||
repositoryOwner,
|
|
||||||
repositoryName,
|
|
||||||
ref,
|
|
||||||
commit
|
|
||||||
)
|
|
||||||
|
|
||||||
expect(getOctokitSpy).not.toHaveBeenCalled()
|
|
||||||
expect(repoGetSpy).not.toHaveBeenCalled()
|
|
||||||
})
|
|
||||||
|
|
||||||
it('matches SHA-256 merge commit info', async () => {
|
|
||||||
const actualHeadSha =
|
|
||||||
'9999999999888888888877777777776666666666555555555544444444443333'
|
|
||||||
setPullRequestContext(sha256Head, sha256Base, sha256Commit)
|
|
||||||
|
|
||||||
await refHelper.checkCommitInfo(
|
|
||||||
'token',
|
|
||||||
`Merge ${actualHeadSha} into ${sha256Base}`,
|
|
||||||
repositoryOwner,
|
|
||||||
repositoryName,
|
|
||||||
ref,
|
|
||||||
sha256Commit
|
|
||||||
)
|
|
||||||
|
|
||||||
expect(getOctokitSpy).toHaveBeenCalledWith(
|
|
||||||
'token',
|
|
||||||
expect.objectContaining({
|
|
||||||
userAgent: expect.stringContaining(
|
|
||||||
`expected_head_sha=${sha256Head};actual_head_sha=${actualHeadSha}`
|
|
||||||
)
|
|
||||||
})
|
|
||||||
)
|
|
||||||
expect(repoGetSpy).toHaveBeenCalledWith({
|
|
||||||
owner: repositoryOwner,
|
|
||||||
repo: repositoryName
|
|
||||||
})
|
|
||||||
expect(debugSpy).toHaveBeenCalledWith(
|
|
||||||
`Expected head sha ${sha256Head}; actual head sha ${actualHeadSha}`
|
|
||||||
)
|
|
||||||
expect(debugSpy).not.toHaveBeenCalledWith('Unexpected message format')
|
|
||||||
})
|
|
||||||
|
|
||||||
it('does not match 50-char hex as a valid merge', async () => {
|
|
||||||
const invalidHeadSha =
|
|
||||||
'99999999998888888888777777777766666666665555555555'
|
|
||||||
setPullRequestContext(sha1Head, sha1Base, commit)
|
|
||||||
|
|
||||||
await refHelper.checkCommitInfo(
|
|
||||||
'token',
|
|
||||||
`Merge ${invalidHeadSha} into ${sha1Base}`,
|
|
||||||
repositoryOwner,
|
|
||||||
repositoryName,
|
|
||||||
ref,
|
|
||||||
commit
|
|
||||||
)
|
|
||||||
|
|
||||||
expect(getOctokitSpy).not.toHaveBeenCalled()
|
|
||||||
expect(repoGetSpy).not.toHaveBeenCalled()
|
|
||||||
expect(debugSpy).toHaveBeenCalledWith('Unexpected message format')
|
|
||||||
})
|
|
||||||
})
|
|
||||||
})
|
})
|
||||||
|
|
|
||||||
|
|
@ -1,9 +0,0 @@
|
||||||
#!/bin/sh
|
|
||||||
|
|
||||||
# Verify tags were fetched
|
|
||||||
TAG_COUNT=$(git -C ./fetch-tags-test tag | wc -l)
|
|
||||||
if [ "$TAG_COUNT" -eq 0 ]; then
|
|
||||||
echo "Expected tags to be fetched, but found none"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
echo "Found $TAG_COUNT tags"
|
|
||||||
80
dist/index.js
vendored
80
dist/index.js
vendored
|
|
@ -653,6 +653,7 @@ const fs = __importStar(__nccwpck_require__(7147));
|
||||||
const fshelper = __importStar(__nccwpck_require__(7219));
|
const fshelper = __importStar(__nccwpck_require__(7219));
|
||||||
const io = __importStar(__nccwpck_require__(7436));
|
const io = __importStar(__nccwpck_require__(7436));
|
||||||
const path = __importStar(__nccwpck_require__(1017));
|
const path = __importStar(__nccwpck_require__(1017));
|
||||||
|
const refHelper = __importStar(__nccwpck_require__(8601));
|
||||||
const regexpHelper = __importStar(__nccwpck_require__(3120));
|
const regexpHelper = __importStar(__nccwpck_require__(3120));
|
||||||
const retryHelper = __importStar(__nccwpck_require__(2155));
|
const retryHelper = __importStar(__nccwpck_require__(2155));
|
||||||
const git_version_1 = __nccwpck_require__(3142);
|
const git_version_1 = __nccwpck_require__(3142);
|
||||||
|
|
@ -830,9 +831,9 @@ class GitCommandManager {
|
||||||
fetch(refSpec, options) {
|
fetch(refSpec, options) {
|
||||||
return __awaiter(this, void 0, void 0, function* () {
|
return __awaiter(this, void 0, void 0, function* () {
|
||||||
const args = ['-c', 'protocol.version=2', 'fetch'];
|
const args = ['-c', 'protocol.version=2', 'fetch'];
|
||||||
// Always use --no-tags for explicit control over tag fetching
|
if (!refSpec.some(x => x === refHelper.tagsRefSpec) && !options.fetchTags) {
|
||||||
// Tags are fetched explicitly via refspec when needed
|
|
||||||
args.push('--no-tags');
|
args.push('--no-tags');
|
||||||
|
}
|
||||||
args.push('--prune', '--no-recurse-submodules');
|
args.push('--prune', '--no-recurse-submodules');
|
||||||
if (options.showProgress) {
|
if (options.showProgress) {
|
||||||
args.push('--progress');
|
args.push('--progress');
|
||||||
|
|
@ -1205,17 +1206,7 @@ class GitCommandManager {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
// Set the user agent
|
// Set the user agent
|
||||||
let gitHttpUserAgent = `git/${this.gitVersion} (github-actions-checkout)`;
|
const gitHttpUserAgent = `git/${this.gitVersion} (github-actions-checkout)`;
|
||||||
// Append orchestration ID if set
|
|
||||||
const orchId = process.env['ACTIONS_ORCHESTRATION_ID'];
|
|
||||||
if (orchId) {
|
|
||||||
// Sanitize the orchestration ID to ensure it contains only valid characters
|
|
||||||
// Valid characters: 0-9, a-z, _, -, .
|
|
||||||
const sanitizedId = orchId.replace(/[^a-z0-9_.-]/gi, '_');
|
|
||||||
if (sanitizedId) {
|
|
||||||
gitHttpUserAgent = `${gitHttpUserAgent} actions_orchestration_id/${sanitizedId}`;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
core.debug(`Set git useragent to: ${gitHttpUserAgent}`);
|
core.debug(`Set git useragent to: ${gitHttpUserAgent}`);
|
||||||
this.gitEnv['GIT_HTTP_USER_AGENT'] = gitHttpUserAgent;
|
this.gitEnv['GIT_HTTP_USER_AGENT'] = gitHttpUserAgent;
|
||||||
});
|
});
|
||||||
|
|
@ -1538,26 +1529,13 @@ function getSource(settings) {
|
||||||
if (!(yield refHelper.testRef(git, settings.ref, settings.commit))) {
|
if (!(yield refHelper.testRef(git, settings.ref, settings.commit))) {
|
||||||
refSpec = refHelper.getRefSpec(settings.ref, settings.commit);
|
refSpec = refHelper.getRefSpec(settings.ref, settings.commit);
|
||||||
yield git.fetch(refSpec, fetchOptions);
|
yield git.fetch(refSpec, fetchOptions);
|
||||||
// Verify the ref now matches. For branches, the targeted fetch above brings
|
|
||||||
// in the specific commit. For tags (fetched by ref), this will fail if
|
|
||||||
// the tag was moved after the workflow was triggered.
|
|
||||||
if (!(yield refHelper.testRef(git, settings.ref, settings.commit))) {
|
|
||||||
throw new Error(`The ref '${settings.ref}' does not point to the expected commit '${settings.commit}'. ` +
|
|
||||||
`The ref may have been updated after the workflow was triggered.`);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
else {
|
else {
|
||||||
fetchOptions.fetchDepth = settings.fetchDepth;
|
fetchOptions.fetchDepth = settings.fetchDepth;
|
||||||
const refSpec = refHelper.getRefSpec(settings.ref, settings.commit, settings.fetchTags);
|
fetchOptions.fetchTags = settings.fetchTags;
|
||||||
|
const refSpec = refHelper.getRefSpec(settings.ref, settings.commit);
|
||||||
yield git.fetch(refSpec, fetchOptions);
|
yield git.fetch(refSpec, fetchOptions);
|
||||||
// For tags, verify the ref still points to the expected commit.
|
|
||||||
// Tags are fetched by ref (not commit), so if a tag was moved after the
|
|
||||||
// workflow was triggered, we would silently check out the wrong commit.
|
|
||||||
if (!(yield refHelper.testRef(git, settings.ref, settings.commit))) {
|
|
||||||
throw new Error(`The ref '${settings.ref}' does not point to the expected commit '${settings.commit}'. ` +
|
|
||||||
`The ref may have been updated after the workflow was triggered.`);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
core.endGroup();
|
core.endGroup();
|
||||||
// Checkout info
|
// Checkout info
|
||||||
|
|
@ -2021,7 +1999,7 @@ function getInputs() {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
// SHA?
|
// SHA?
|
||||||
else if (result.ref.match(/^(?:[0-9a-fA-F]{40}|[0-9a-fA-F]{64})$/)) {
|
else if (result.ref.match(/^[0-9a-fA-F]{40}$/)) {
|
||||||
result.commit = result.ref;
|
result.commit = result.ref;
|
||||||
result.ref = '';
|
result.ref = '';
|
||||||
}
|
}
|
||||||
|
|
@ -2296,67 +2274,53 @@ function getRefSpecForAllHistory(ref, commit) {
|
||||||
}
|
}
|
||||||
return result;
|
return result;
|
||||||
}
|
}
|
||||||
function getRefSpec(ref, commit, fetchTags) {
|
function getRefSpec(ref, commit) {
|
||||||
if (!ref && !commit) {
|
if (!ref && !commit) {
|
||||||
throw new Error('Args ref and commit cannot both be empty');
|
throw new Error('Args ref and commit cannot both be empty');
|
||||||
}
|
}
|
||||||
const upperRef = (ref || '').toUpperCase();
|
const upperRef = (ref || '').toUpperCase();
|
||||||
const result = [];
|
|
||||||
// When fetchTags is true, always include the tags refspec
|
|
||||||
if (fetchTags) {
|
|
||||||
result.push(exports.tagsRefSpec);
|
|
||||||
}
|
|
||||||
// SHA
|
// SHA
|
||||||
if (commit) {
|
if (commit) {
|
||||||
// refs/heads
|
// refs/heads
|
||||||
if (upperRef.startsWith('REFS/HEADS/')) {
|
if (upperRef.startsWith('REFS/HEADS/')) {
|
||||||
const branch = ref.substring('refs/heads/'.length);
|
const branch = ref.substring('refs/heads/'.length);
|
||||||
result.push(`+${commit}:refs/remotes/origin/${branch}`);
|
return [`+${commit}:refs/remotes/origin/${branch}`];
|
||||||
}
|
}
|
||||||
// refs/pull/
|
// refs/pull/
|
||||||
else if (upperRef.startsWith('REFS/PULL/')) {
|
else if (upperRef.startsWith('REFS/PULL/')) {
|
||||||
const branch = ref.substring('refs/pull/'.length);
|
const branch = ref.substring('refs/pull/'.length);
|
||||||
result.push(`+${commit}:refs/remotes/pull/${branch}`);
|
return [`+${commit}:refs/remotes/pull/${branch}`];
|
||||||
}
|
}
|
||||||
// refs/tags/
|
// refs/tags/
|
||||||
else if (upperRef.startsWith('REFS/TAGS/')) {
|
else if (upperRef.startsWith('REFS/TAGS/')) {
|
||||||
if (!fetchTags) {
|
return [`+${commit}:${ref}`];
|
||||||
result.push(`+${ref}:${ref}`);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
// Otherwise no destination ref
|
// Otherwise no destination ref
|
||||||
else {
|
else {
|
||||||
result.push(commit);
|
return [commit];
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
// Unqualified ref, check for a matching branch or tag
|
// Unqualified ref, check for a matching branch or tag
|
||||||
else if (!upperRef.startsWith('REFS/')) {
|
else if (!upperRef.startsWith('REFS/')) {
|
||||||
result.push(`+refs/heads/${ref}*:refs/remotes/origin/${ref}*`);
|
return [
|
||||||
if (!fetchTags) {
|
`+refs/heads/${ref}*:refs/remotes/origin/${ref}*`,
|
||||||
result.push(`+refs/tags/${ref}*:refs/tags/${ref}*`);
|
`+refs/tags/${ref}*:refs/tags/${ref}*`
|
||||||
}
|
];
|
||||||
}
|
}
|
||||||
// refs/heads/
|
// refs/heads/
|
||||||
else if (upperRef.startsWith('REFS/HEADS/')) {
|
else if (upperRef.startsWith('REFS/HEADS/')) {
|
||||||
const branch = ref.substring('refs/heads/'.length);
|
const branch = ref.substring('refs/heads/'.length);
|
||||||
result.push(`+${ref}:refs/remotes/origin/${branch}`);
|
return [`+${ref}:refs/remotes/origin/${branch}`];
|
||||||
}
|
}
|
||||||
// refs/pull/
|
// refs/pull/
|
||||||
else if (upperRef.startsWith('REFS/PULL/')) {
|
else if (upperRef.startsWith('REFS/PULL/')) {
|
||||||
const branch = ref.substring('refs/pull/'.length);
|
const branch = ref.substring('refs/pull/'.length);
|
||||||
result.push(`+${ref}:refs/remotes/pull/${branch}`);
|
return [`+${ref}:refs/remotes/pull/${branch}`];
|
||||||
}
|
}
|
||||||
// refs/tags/
|
// refs/tags/
|
||||||
else if (upperRef.startsWith('REFS/TAGS/')) {
|
|
||||||
if (!fetchTags) {
|
|
||||||
result.push(`+${ref}:${ref}`);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
// Other refs
|
|
||||||
else {
|
else {
|
||||||
result.push(`+${ref}:${ref}`);
|
return [`+${ref}:${ref}`];
|
||||||
}
|
}
|
||||||
return result;
|
|
||||||
}
|
}
|
||||||
/**
|
/**
|
||||||
* Tests whether the initial fetch created the ref at the expected commit
|
* Tests whether the initial fetch created the ref at the expected commit
|
||||||
|
|
@ -2392,9 +2356,7 @@ function testRef(git, ref, commit) {
|
||||||
// refs/tags/
|
// refs/tags/
|
||||||
else if (upperRef.startsWith('REFS/TAGS/')) {
|
else if (upperRef.startsWith('REFS/TAGS/')) {
|
||||||
const tagName = ref.substring('refs/tags/'.length);
|
const tagName = ref.substring('refs/tags/'.length);
|
||||||
// Use ^{commit} to dereference annotated tags to their underlying commit
|
return ((yield git.tagExists(tagName)) && commit === (yield git.revParse(ref)));
|
||||||
return ((yield git.tagExists(tagName)) &&
|
|
||||||
commit === (yield git.revParse(`${ref}^{commit}`)));
|
|
||||||
}
|
}
|
||||||
// Unexpected
|
// Unexpected
|
||||||
else {
|
else {
|
||||||
|
|
@ -2444,7 +2406,7 @@ function checkCommitInfo(token, commitInfo, repositoryOwner, repositoryName, ref
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
// Extract details from message
|
// Extract details from message
|
||||||
const match = commitInfo.match(/Merge ([0-9a-f]{40}|[0-9a-f]{64}) into ([0-9a-f]{40}|[0-9a-f]{64})/);
|
const match = commitInfo.match(/Merge ([0-9a-f]{40}) into ([0-9a-f]{40})/);
|
||||||
if (!match) {
|
if (!match) {
|
||||||
core.debug('Unexpected message format');
|
core.debug('Unexpected message format');
|
||||||
return;
|
return;
|
||||||
|
|
|
||||||
|
|
@ -37,6 +37,7 @@ export interface IGitCommandManager {
|
||||||
options: {
|
options: {
|
||||||
filter?: string
|
filter?: string
|
||||||
fetchDepth?: number
|
fetchDepth?: number
|
||||||
|
fetchTags?: boolean
|
||||||
showProgress?: boolean
|
showProgress?: boolean
|
||||||
}
|
}
|
||||||
): Promise<void>
|
): Promise<void>
|
||||||
|
|
@ -279,13 +280,14 @@ class GitCommandManager {
|
||||||
options: {
|
options: {
|
||||||
filter?: string
|
filter?: string
|
||||||
fetchDepth?: number
|
fetchDepth?: number
|
||||||
|
fetchTags?: boolean
|
||||||
showProgress?: boolean
|
showProgress?: boolean
|
||||||
}
|
}
|
||||||
): Promise<void> {
|
): Promise<void> {
|
||||||
const args = ['-c', 'protocol.version=2', 'fetch']
|
const args = ['-c', 'protocol.version=2', 'fetch']
|
||||||
// Always use --no-tags for explicit control over tag fetching
|
if (!refSpec.some(x => x === refHelper.tagsRefSpec) && !options.fetchTags) {
|
||||||
// Tags are fetched explicitly via refspec when needed
|
|
||||||
args.push('--no-tags')
|
args.push('--no-tags')
|
||||||
|
}
|
||||||
|
|
||||||
args.push('--prune', '--no-recurse-submodules')
|
args.push('--prune', '--no-recurse-submodules')
|
||||||
if (options.showProgress) {
|
if (options.showProgress) {
|
||||||
|
|
@ -728,19 +730,7 @@ class GitCommandManager {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
// Set the user agent
|
// Set the user agent
|
||||||
let gitHttpUserAgent = `git/${this.gitVersion} (github-actions-checkout)`
|
const gitHttpUserAgent = `git/${this.gitVersion} (github-actions-checkout)`
|
||||||
|
|
||||||
// Append orchestration ID if set
|
|
||||||
const orchId = process.env['ACTIONS_ORCHESTRATION_ID']
|
|
||||||
if (orchId) {
|
|
||||||
// Sanitize the orchestration ID to ensure it contains only valid characters
|
|
||||||
// Valid characters: 0-9, a-z, _, -, .
|
|
||||||
const sanitizedId = orchId.replace(/[^a-z0-9_.-]/gi, '_')
|
|
||||||
if (sanitizedId) {
|
|
||||||
gitHttpUserAgent = `${gitHttpUserAgent} actions_orchestration_id/${sanitizedId}`
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
core.debug(`Set git useragent to: ${gitHttpUserAgent}`)
|
core.debug(`Set git useragent to: ${gitHttpUserAgent}`)
|
||||||
this.gitEnv['GIT_HTTP_USER_AGENT'] = gitHttpUserAgent
|
this.gitEnv['GIT_HTTP_USER_AGENT'] = gitHttpUserAgent
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -159,6 +159,7 @@ export async function getSource(settings: IGitSourceSettings): Promise<void> {
|
||||||
const fetchOptions: {
|
const fetchOptions: {
|
||||||
filter?: string
|
filter?: string
|
||||||
fetchDepth?: number
|
fetchDepth?: number
|
||||||
|
fetchTags?: boolean
|
||||||
showProgress?: boolean
|
showProgress?: boolean
|
||||||
} = {}
|
} = {}
|
||||||
|
|
||||||
|
|
@ -181,35 +182,12 @@ export async function getSource(settings: IGitSourceSettings): Promise<void> {
|
||||||
if (!(await refHelper.testRef(git, settings.ref, settings.commit))) {
|
if (!(await refHelper.testRef(git, settings.ref, settings.commit))) {
|
||||||
refSpec = refHelper.getRefSpec(settings.ref, settings.commit)
|
refSpec = refHelper.getRefSpec(settings.ref, settings.commit)
|
||||||
await git.fetch(refSpec, fetchOptions)
|
await git.fetch(refSpec, fetchOptions)
|
||||||
|
|
||||||
// Verify the ref now matches. For branches, the targeted fetch above brings
|
|
||||||
// in the specific commit. For tags (fetched by ref), this will fail if
|
|
||||||
// the tag was moved after the workflow was triggered.
|
|
||||||
if (!(await refHelper.testRef(git, settings.ref, settings.commit))) {
|
|
||||||
throw new Error(
|
|
||||||
`The ref '${settings.ref}' does not point to the expected commit '${settings.commit}'. ` +
|
|
||||||
`The ref may have been updated after the workflow was triggered.`
|
|
||||||
)
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
fetchOptions.fetchDepth = settings.fetchDepth
|
fetchOptions.fetchDepth = settings.fetchDepth
|
||||||
const refSpec = refHelper.getRefSpec(
|
fetchOptions.fetchTags = settings.fetchTags
|
||||||
settings.ref,
|
const refSpec = refHelper.getRefSpec(settings.ref, settings.commit)
|
||||||
settings.commit,
|
|
||||||
settings.fetchTags
|
|
||||||
)
|
|
||||||
await git.fetch(refSpec, fetchOptions)
|
await git.fetch(refSpec, fetchOptions)
|
||||||
|
|
||||||
// For tags, verify the ref still points to the expected commit.
|
|
||||||
// Tags are fetched by ref (not commit), so if a tag was moved after the
|
|
||||||
// workflow was triggered, we would silently check out the wrong commit.
|
|
||||||
if (!(await refHelper.testRef(git, settings.ref, settings.commit))) {
|
|
||||||
throw new Error(
|
|
||||||
`The ref '${settings.ref}' does not point to the expected commit '${settings.commit}'. ` +
|
|
||||||
`The ref may have been updated after the workflow was triggered.`
|
|
||||||
)
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
core.endGroup()
|
core.endGroup()
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -71,7 +71,7 @@ export async function getInputs(): Promise<IGitSourceSettings> {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
// SHA?
|
// SHA?
|
||||||
else if (result.ref.match(/^(?:[0-9a-fA-F]{40}|[0-9a-fA-F]{64})$/)) {
|
else if (result.ref.match(/^[0-9a-fA-F]{40}$/)) {
|
||||||
result.commit = result.ref
|
result.commit = result.ref
|
||||||
result.ref = ''
|
result.ref = ''
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -76,75 +76,55 @@ export function getRefSpecForAllHistory(ref: string, commit: string): string[] {
|
||||||
return result
|
return result
|
||||||
}
|
}
|
||||||
|
|
||||||
export function getRefSpec(
|
export function getRefSpec(ref: string, commit: string): string[] {
|
||||||
ref: string,
|
|
||||||
commit: string,
|
|
||||||
fetchTags?: boolean
|
|
||||||
): string[] {
|
|
||||||
if (!ref && !commit) {
|
if (!ref && !commit) {
|
||||||
throw new Error('Args ref and commit cannot both be empty')
|
throw new Error('Args ref and commit cannot both be empty')
|
||||||
}
|
}
|
||||||
|
|
||||||
const upperRef = (ref || '').toUpperCase()
|
const upperRef = (ref || '').toUpperCase()
|
||||||
const result: string[] = []
|
|
||||||
|
|
||||||
// When fetchTags is true, always include the tags refspec
|
|
||||||
if (fetchTags) {
|
|
||||||
result.push(tagsRefSpec)
|
|
||||||
}
|
|
||||||
|
|
||||||
// SHA
|
// SHA
|
||||||
if (commit) {
|
if (commit) {
|
||||||
// refs/heads
|
// refs/heads
|
||||||
if (upperRef.startsWith('REFS/HEADS/')) {
|
if (upperRef.startsWith('REFS/HEADS/')) {
|
||||||
const branch = ref.substring('refs/heads/'.length)
|
const branch = ref.substring('refs/heads/'.length)
|
||||||
result.push(`+${commit}:refs/remotes/origin/${branch}`)
|
return [`+${commit}:refs/remotes/origin/${branch}`]
|
||||||
}
|
}
|
||||||
// refs/pull/
|
// refs/pull/
|
||||||
else if (upperRef.startsWith('REFS/PULL/')) {
|
else if (upperRef.startsWith('REFS/PULL/')) {
|
||||||
const branch = ref.substring('refs/pull/'.length)
|
const branch = ref.substring('refs/pull/'.length)
|
||||||
result.push(`+${commit}:refs/remotes/pull/${branch}`)
|
return [`+${commit}:refs/remotes/pull/${branch}`]
|
||||||
}
|
}
|
||||||
// refs/tags/
|
// refs/tags/
|
||||||
else if (upperRef.startsWith('REFS/TAGS/')) {
|
else if (upperRef.startsWith('REFS/TAGS/')) {
|
||||||
if (!fetchTags) {
|
return [`+${commit}:${ref}`]
|
||||||
result.push(`+${ref}:${ref}`)
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
// Otherwise no destination ref
|
// Otherwise no destination ref
|
||||||
else {
|
else {
|
||||||
result.push(commit)
|
return [commit]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
// Unqualified ref, check for a matching branch or tag
|
// Unqualified ref, check for a matching branch or tag
|
||||||
else if (!upperRef.startsWith('REFS/')) {
|
else if (!upperRef.startsWith('REFS/')) {
|
||||||
result.push(`+refs/heads/${ref}*:refs/remotes/origin/${ref}*`)
|
return [
|
||||||
if (!fetchTags) {
|
`+refs/heads/${ref}*:refs/remotes/origin/${ref}*`,
|
||||||
result.push(`+refs/tags/${ref}*:refs/tags/${ref}*`)
|
`+refs/tags/${ref}*:refs/tags/${ref}*`
|
||||||
}
|
]
|
||||||
}
|
}
|
||||||
// refs/heads/
|
// refs/heads/
|
||||||
else if (upperRef.startsWith('REFS/HEADS/')) {
|
else if (upperRef.startsWith('REFS/HEADS/')) {
|
||||||
const branch = ref.substring('refs/heads/'.length)
|
const branch = ref.substring('refs/heads/'.length)
|
||||||
result.push(`+${ref}:refs/remotes/origin/${branch}`)
|
return [`+${ref}:refs/remotes/origin/${branch}`]
|
||||||
}
|
}
|
||||||
// refs/pull/
|
// refs/pull/
|
||||||
else if (upperRef.startsWith('REFS/PULL/')) {
|
else if (upperRef.startsWith('REFS/PULL/')) {
|
||||||
const branch = ref.substring('refs/pull/'.length)
|
const branch = ref.substring('refs/pull/'.length)
|
||||||
result.push(`+${ref}:refs/remotes/pull/${branch}`)
|
return [`+${ref}:refs/remotes/pull/${branch}`]
|
||||||
}
|
}
|
||||||
// refs/tags/
|
// refs/tags/
|
||||||
else if (upperRef.startsWith('REFS/TAGS/')) {
|
|
||||||
if (!fetchTags) {
|
|
||||||
result.push(`+${ref}:${ref}`)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
// Other refs
|
|
||||||
else {
|
else {
|
||||||
result.push(`+${ref}:${ref}`)
|
return [`+${ref}:${ref}`]
|
||||||
}
|
}
|
||||||
|
|
||||||
return result
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
@ -190,10 +170,8 @@ export async function testRef(
|
||||||
// refs/tags/
|
// refs/tags/
|
||||||
else if (upperRef.startsWith('REFS/TAGS/')) {
|
else if (upperRef.startsWith('REFS/TAGS/')) {
|
||||||
const tagName = ref.substring('refs/tags/'.length)
|
const tagName = ref.substring('refs/tags/'.length)
|
||||||
// Use ^{commit} to dereference annotated tags to their underlying commit
|
|
||||||
return (
|
return (
|
||||||
(await git.tagExists(tagName)) &&
|
(await git.tagExists(tagName)) && commit === (await git.revParse(ref))
|
||||||
commit === (await git.revParse(`${ref}^{commit}`))
|
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
// Unexpected
|
// Unexpected
|
||||||
|
|
@ -258,9 +236,7 @@ export async function checkCommitInfo(
|
||||||
}
|
}
|
||||||
|
|
||||||
// Extract details from message
|
// Extract details from message
|
||||||
const match = commitInfo.match(
|
const match = commitInfo.match(/Merge ([0-9a-f]{40}) into ([0-9a-f]{40})/)
|
||||||
/Merge ([0-9a-f]{40}|[0-9a-f]{64}) into ([0-9a-f]{40}|[0-9a-f]{64})/
|
|
||||||
)
|
|
||||||
if (!match) {
|
if (!match) {
|
||||||
core.debug('Unexpected message format')
|
core.debug('Unexpected message format')
|
||||||
return
|
return
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue