actions/checkout
1
0
Fork 0
mirror of https://github.com/actions/checkout.git synced 2024-11-26 18:22:15 +00:00
Code Issues Releases Wiki Activity

Log more comprehensive commit information after checkout

Browse source 
After checkout, the action currently logs the SHA-1 of the top most
commit. There are cases when this information is not very telling,
though. Consider the case of some automation that applies one or more
commits on top of what the repository already contained. If something
like this happens, the SHA-1 may be meaningless to the user. Given that
this information is unlikely to be programmatically evaluated, we may as
well include a bit more than only the commit SHA-1, in the hopes that it
provides some more useful information to the user.
To that end, this change proposes logging not just the SHA-1, but also
the commit summary. At the very least that gives a user a straw what to
look for if the commit is indeed not available locally, in the best case
we end up with a message about a merge commit, that helps users glean
information about the base commit as well:
> e0dcaaee9063ab55ffe2e0c8dcffb4a9611208f9 Merge e3aafdc7d10cf5002e39c5d4fe867d1b27d0ff7b into b77ffb30cfc5f58e957571d8541c6a7e3da19221
This commit is contained in:
Daniel Müller 2022-07-19 15:35:29 -07:00
parent 2541b1294d
commit 3a2088e347
No known key found for this signature in database
GPG key ID: 952DD6F8F34D8B8E
2 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
dist/index.js vendored
View file

@ -7478,8 +7478,8 @@ function getSource(settings) {
} }
// Get commit information // Get commit information
const commitInfo = yield git.log1(); const commitInfo = yield git.log1();
// Log commit sha // Log commit information
yield git.log1("--format='%H'"); yield git.log1("--format=oneline");
// Check for incorrect pull request merge commit // Check for incorrect pull request merge commit
yield refHelper.checkCommitInfo(settings.authToken, commitInfo, settings.repositoryOwner, settings.repositoryName, settings.ref, settings.commit); yield refHelper.checkCommitInfo(settings.authToken, commitInfo, settings.repositoryOwner, settings.repositoryName, settings.ref, settings.commit);
} }

4
src/git-source-provider.ts
View file

@ -222,8 +222,8 @@ export async function getSource(settings: IGitSourceSettings): Promise<void> {
// Get commit information // Get commit information
const commitInfo = await git.log1() const commitInfo = await git.log1()
// Log commit sha // Log commit information
await git.log1("--format='%H'") await git.log1("--format=oneline")
// Check for incorrect pull request merge commit // Check for incorrect pull request merge commit
await refHelper.checkCommitInfo( await refHelper.checkCommitInfo(