Support coustom commit messages

Author: actions-user

README.md

@@ -10,7 +10,8 @@ Syncs markdown documentation files in a repo to its wiki
 | rootDocsFolder | Relative path within the repo to the root documentation folder | No, default is the repo's root |
 | convertRootReadmeToHomePage | If true, the `README.md` file at the root of the repo will be renamed to `Home.md` in the wiki so that it is used as the wiki homepage | No, default is false |
 | useHeaderForWikiName | If true, will extract the top-line header (denoted by a single `#`) and use that as the wiki page's name. Note: if this results in a name collision the sync will fail | No, default is false and wiki names will be the relative path to the file with `/` converted to `__` (e.g. `path/to/doc.md` becomes `path__to_doc.md`) |
-| useHeaderForWikiName | If set, inserts a header at the top of each wiki file with the given format<br/>Supports the following format subsitutions:<br/>- `{sourceFileLink}`: the absolute url to the source file in the repo | No, default will not add a header |
+| customWikiFileHeaderFormat | If set, inserts a header at the top of each wiki file with the given format<br/>Supports the following format subsitutions:<br/>- `{sourceFileLink}`: the absolute url to the source file in the repo | No, default will not add a header |
+| customCommitMessageFormat | If set, uses the given format for the commit message to the wiki. Useful to correlate changes to the source.<br/>Supports the following format subsitutions:<br/>- `{commitMessage}`: the latest commit message for HEAD<br/>- `{shaFull}`: the full SHA of HEAD<br/>- `{shaShort}`: the short SHA of HEAD | No, default is `"Sync Files"` |
 
 ## How it works
 

action.ps1

@@ -15,6 +15,7 @@ $rootDocsFolder = Get-ActionInput rootDocsFolder
 $convertRootReadmeToHomePage = Get-ActionInput convertRootReadmeToHomePage
 $useHeaderForWikiName = Get-ActionInput useHeaderForWikiName
 $customWikiFileHeaderFormat = Get-ActionInput customWikiFileHeaderFormat
+$customCommitMessageFormat = Get-ActionInput customCommitMessageFormat
 
 $repositoryName = $env:GITHUB_REPOSITORY
 
@@ -23,6 +24,8 @@ $repositoryCloneUrl = "https://[email protected]/$repositoryName"
 
 $wikiRepoDirectory = ($repositoryName -split "/")[-1] + ".wiki"
 
+$sourceRepoDirectory = $pwd.Path
+
 if (-not $defaultBranch)
 {
     $defaultBranch = git branch --show-current
@@ -258,6 +261,30 @@ Function ProcessWikiFile()
     Set-Content -Path $file.FullName -Value $content -Force
 }
 
+Function GetWikiCommitMessage()
+{
+    if (-not $customCommitMessageFormat)
+    {
+        return "Sync Files"
+    }
+
+    Push-Location $sourceRepoDirectory
+
+    $commitMessage = $customCommitMessageFormat
+
+    $message = git log -1 --pretty=%B
+    $commitMessage = $commitMessage -replace "{commitMessage}", $message
+
+    $shaFull = git rev-parse HEAD
+    $commitMessage = $commitMessage -replace "{shaFull}", $shaFull
+
+    $shaShort = git rev-parse --short HEAD
+    $commitMessage = $commitMessage -replace "{shaShort}", $shaShort
+
+    Pop-Location
+    return $commitMessage
+}
+
 git config --global user.email "[email protected]"
 git config --global user.name "GitHub Action"
 
@@ -278,8 +305,10 @@ Push-Location ..\$wikiRepoDirectory
 Write-ActionInfo "Post-processing wiki files..."
 ProcessWikiDirectory
 
+$commitMessage = GetWikiCommitMessage
+
 Write-ActionInfo "Pushing wiki"
 git add .
-git commit -am "Sync Files"
+git commit -am $commitMessage
 git push
 Pop-Location

action.yml

@@ -32,7 +32,15 @@ inputs:
       Supports the following format subsitutions:
         - {sourceFileLink}: the absolute url to the source file in the repo
     required: false
-    default:
+
+  customCommitMessageFormat:
+    description: |
+      If set, uses the given format for the commit message to the wiki. Useful to correlate changes to the source.
+      Supports the following format subsitutions:
+        - {commitMessage}: the latest commit message for HEAD
+        - {shaFull}: the full SHA of HEAD
+        - {shaShort}: the short SHA of HEAD
+    required: false
 
 branding:
   color: purple