diff --git a/.github/workflows/cpr-example-command.yml b/.github/workflows/cpr-example-command.yml
index 00d793e..a545dfc 100644
--- a/.github/workflows/cpr-example-command.yml
+++ b/.github/workflows/cpr-example-command.yml
@@ -18,6 +18,7 @@ jobs:
commit-message: Update report
committer: GitHub <noreply@github.com>
author: ${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>
+ signoff: false
title: '[Example] Update report'
body: |
Update report
diff --git a/README.md b/README.md
index 9a5b5a4..d916ac1 100644
--- a/README.md
+++ b/README.md
@@ -45,6 +45,7 @@ All inputs are **optional**. If not set, sensible defaults will be used.
| `commit-message` | The message to use when committing changes. | `[create-pull-request] automated change` |
| `committer` | The committer name and email address in the format `Display Name <email@address.com>`. Defaults to the GitHub Actions bot user. | `GitHub <noreply@github.com>` |
| `author` | The author name and email address in the format `Display Name <email@address.com>`. Defaults to the user who triggered the workflow run. | `${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>` |
+| `signoff` | Add `Signed-off-by` line by the committer at the end of the commit log message. | `false` |
| `branch` | The pull request branch name. | `create-pull-request/patch` |
| `branch-suffix` | The branch suffix type when using the alternative branching strategy. Valid values are `random`, `timestamp` and `short-commit-hash`. See [Alternative strategy](#alternative-strategy---always-create-a-new-pull-request-branch) for details. | |
| `base` | Sets the pull request base branch. | Defaults to the branch checked out in the workflow. |
@@ -156,7 +157,7 @@ To create a project card for the pull request, pass the `pull-request-number` st
## Reference Example
-The following workflow is a reference example that sets all the main inputs.
+The following workflow is a reference example that sets many of the main inputs.
See [examples](docs/examples.md) for more realistic use cases.
@@ -180,6 +181,7 @@ jobs:
commit-message: Update report
committer: GitHub <noreply@github.com>
author: ${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>
+ signoff: false
branch: example-patches
title: '[Example] Update report'
body: |
diff --git a/__test__/create-or-update-branch.int.test.ts b/__test__/create-or-update-branch.int.test.ts
index 335d20c..dfb01fd 100644
--- a/__test__/create-or-update-branch.int.test.ts
+++ b/__test__/create-or-update-branch.int.test.ts
@@ -200,7 +200,8 @@ describe('create-or-update-branch tests', () => {
commitMessage,
'',
BRANCH,
- REMOTE_NAME
+ REMOTE_NAME,
+ false
)
expect(result.action).toEqual('none')
expect(await gitLogMatches([INIT_COMMIT_MESSAGE])).toBeTruthy()
@@ -215,7 +216,8 @@ describe('create-or-update-branch tests', () => {
commitMessage,
'',
BRANCH,
- REMOTE_NAME
+ REMOTE_NAME,
+ false
)
expect(result.action).toEqual('created')
expect(await getFileContent(TRACKED_FILE)).toEqual(trackedContent)
@@ -241,7 +243,8 @@ describe('create-or-update-branch tests', () => {
_commitMessage,
'',
BRANCH,
- REMOTE_NAME
+ REMOTE_NAME,
+ false
)
expect(_result.action).toEqual('updated')
expect(_result.hasDiffWithBase).toBeTruthy()
@@ -260,7 +263,8 @@ describe('create-or-update-branch tests', () => {
commitMessage,
'',
BRANCH,
- REMOTE_NAME
+ REMOTE_NAME,
+ false
)
expect(result.action).toEqual('created')
expect(await getFileContent(UNTRACKED_FILE)).toEqual(untrackedContent)
@@ -286,7 +290,8 @@ describe('create-or-update-branch tests', () => {
_commitMessage,
'',
BRANCH,
- REMOTE_NAME
+ REMOTE_NAME,
+ false
)
expect(_result.action).toEqual('updated')
expect(_result.hasDiffWithBase).toBeTruthy()
@@ -307,7 +312,8 @@ describe('create-or-update-branch tests', () => {
commitMessage,
'',
BRANCH,
- REMOTE_NAME
+ REMOTE_NAME,
+ false
)
expect(result.action).toEqual('created')
expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@@ -334,7 +340,8 @@ describe('create-or-update-branch tests', () => {
_commitMessage,
'',
BRANCH,
- REMOTE_NAME
+ REMOTE_NAME,
+ false
)
expect(_result.action).toEqual('none')
expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@@ -353,7 +360,8 @@ describe('create-or-update-branch tests', () => {
commitMessage,
'',
BRANCH,
- REMOTE_NAME
+ REMOTE_NAME,
+ false
)
expect(result.action).toEqual('created')
expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@@ -388,7 +396,8 @@ describe('create-or-update-branch tests', () => {
_commitMessage,
'',
BRANCH,
- REMOTE_NAME
+ REMOTE_NAME,
+ false
)
expect(_result.action).toEqual('updated')
expect(_result.hasDiffWithBase).toBeTruthy()
@@ -417,7 +426,8 @@ describe('create-or-update-branch tests', () => {
commitMessage,
'',
BRANCH,
- REMOTE_NAME
+ REMOTE_NAME,
+ false
)
expect(result.action).toEqual('created')
expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@@ -443,7 +453,8 @@ describe('create-or-update-branch tests', () => {
_commitMessage,
'',
BRANCH,
- REMOTE_NAME
+ REMOTE_NAME,
+ false
)
expect(_result.action).toEqual('updated')
expect(_result.hasDiffWithBase).toBeFalsy()
@@ -462,7 +473,8 @@ describe('create-or-update-branch tests', () => {
commitMessage,
'',
BRANCH,
- REMOTE_NAME
+ REMOTE_NAME,
+ false
)
expect(result.action).toEqual('created')
expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@@ -500,7 +512,8 @@ describe('create-or-update-branch tests', () => {
_commitMessage,
'',
BRANCH,
- REMOTE_NAME
+ REMOTE_NAME,
+ false
)
expect(_result.action).toEqual('updated')
expect(_result.hasDiffWithBase).toBeFalsy()
@@ -520,7 +533,8 @@ describe('create-or-update-branch tests', () => {
commitMessage,
'',
BRANCH,
- REMOTE_NAME
+ REMOTE_NAME,
+ false
)
expect(result.action).toEqual('created')
expect(await getFileContent(TRACKED_FILE)).toEqual(commits.changes.tracked)
@@ -549,7 +563,8 @@ describe('create-or-update-branch tests', () => {
_commitMessage,
'',
BRANCH,
- REMOTE_NAME
+ REMOTE_NAME,
+ false
)
expect(_result.action).toEqual('updated')
expect(_result.hasDiffWithBase).toBeTruthy()
@@ -573,7 +588,8 @@ describe('create-or-update-branch tests', () => {
commitMessage,
'',
BRANCH,
- REMOTE_NAME
+ REMOTE_NAME,
+ false
)
expect(result.action).toEqual('created')
expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@@ -606,7 +622,8 @@ describe('create-or-update-branch tests', () => {
_commitMessage,
'',
BRANCH,
- REMOTE_NAME
+ REMOTE_NAME,
+ false
)
expect(_result.action).toEqual('updated')
expect(_result.hasDiffWithBase).toBeTruthy()
@@ -632,7 +649,8 @@ describe('create-or-update-branch tests', () => {
commitMessage,
'',
BRANCH,
- REMOTE_NAME
+ REMOTE_NAME,
+ false
)
expect(result.action).toEqual('created')
expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@@ -673,7 +691,8 @@ describe('create-or-update-branch tests', () => {
_commitMessage,
'',
BRANCH,
- REMOTE_NAME
+ REMOTE_NAME,
+ false
)
expect(_result.action).toEqual('updated')
expect(_result.hasDiffWithBase).toBeTruthy()
@@ -698,7 +717,8 @@ describe('create-or-update-branch tests', () => {
commitMessage,
'',
BRANCH,
- FORK_REMOTE_NAME
+ FORK_REMOTE_NAME,
+ false
)
expect(result.action).toEqual('created')
expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@@ -725,7 +745,8 @@ describe('create-or-update-branch tests', () => {
_commitMessage,
'',
BRANCH,
- FORK_REMOTE_NAME
+ FORK_REMOTE_NAME,
+ false
)
expect(_result.action).toEqual('updated')
expect(_result.hasDiffWithBase).toBeTruthy()
@@ -736,6 +757,69 @@ describe('create-or-update-branch tests', () => {
).toBeTruthy()
})
+ it('tests create and update with signoff on commit', async () => {
+ // Create tracked and untracked file changes
+ const changes = await createChanges()
+ const commitMessage = uuidv4()
+ const result = await createOrUpdateBranch(
+ git,
+ commitMessage,
+ '',
+ BRANCH,
+ REMOTE_NAME,
+ true
+ )
+ expect(result.action).toEqual('created')
+ expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
+ expect(await getFileContent(UNTRACKED_FILE)).toEqual(changes.untracked)
+ expect(
+ await gitLogMatches([commitMessage, INIT_COMMIT_MESSAGE])
+ ).toBeTruthy()
+ // Check signoff in commit body
+ const commitBody = (
+ await git.exec(['log', `-1`, '--format=%b'])
+ ).stdout.trim()
+ expect(commitBody).toEqual(
+ 'Signed-off-by: Committer Name <committer@example.com>'
+ )
+
+ // Push pull request branch to remote
+ await git.push([
+ '--force-with-lease',
+ REMOTE_NAME,
+ `HEAD:refs/heads/${BRANCH}`
+ ])
+
+ await afterTest(false)
+ await beforeTest()
+
+ // Create tracked and untracked file changes
+ const _changes = await createChanges()
+ const _commitMessage = uuidv4()
+ const _result = await createOrUpdateBranch(
+ git,
+ _commitMessage,
+ '',
+ BRANCH,
+ REMOTE_NAME,
+ true
+ )
+ expect(_result.action).toEqual('updated')
+ expect(_result.hasDiffWithBase).toBeTruthy()
+ expect(await getFileContent(TRACKED_FILE)).toEqual(_changes.tracked)
+ expect(await getFileContent(UNTRACKED_FILE)).toEqual(_changes.untracked)
+ expect(
+ await gitLogMatches([_commitMessage, INIT_COMMIT_MESSAGE])
+ ).toBeTruthy()
+ // Check signoff in commit body
+ const _commitBody = (
+ await git.exec(['log', `-1`, '--format=%b'])
+ ).stdout.trim()
+ expect(_commitBody).toEqual(
+ 'Signed-off-by: Committer Name <committer@example.com>'
+ )
+ })
+
// Working Base is Not Base (WBNB)
it('tests no changes resulting in no new branch being created (WBNB)', async () => {
@@ -748,7 +832,8 @@ describe('create-or-update-branch tests', () => {
commitMessage,
BASE,
BRANCH,
- REMOTE_NAME
+ REMOTE_NAME,
+ false
)
expect(result.action).toEqual('none')
expect(await gitLogMatches([INIT_COMMIT_MESSAGE])).toBeTruthy()
@@ -766,7 +851,8 @@ describe('create-or-update-branch tests', () => {
commitMessage,
BASE,
BRANCH,
- REMOTE_NAME
+ REMOTE_NAME,
+ false
)
expect(result.action).toEqual('created')
expect(await getFileContent(TRACKED_FILE)).toEqual(trackedContent)
@@ -795,7 +881,8 @@ describe('create-or-update-branch tests', () => {
_commitMessage,
BASE,
BRANCH,
- REMOTE_NAME
+ REMOTE_NAME,
+ false
)
expect(_result.action).toEqual('updated')
expect(_result.hasDiffWithBase).toBeTruthy()
@@ -817,7 +904,8 @@ describe('create-or-update-branch tests', () => {
commitMessage,
BASE,
BRANCH,
- REMOTE_NAME
+ REMOTE_NAME,
+ false
)
expect(result.action).toEqual('created')
expect(await getFileContent(UNTRACKED_FILE)).toEqual(untrackedContent)
@@ -846,7 +934,8 @@ describe('create-or-update-branch tests', () => {
_commitMessage,
BASE,
BRANCH,
- REMOTE_NAME
+ REMOTE_NAME,
+ false
)
expect(_result.action).toEqual('updated')
expect(_result.hasDiffWithBase).toBeTruthy()
@@ -870,7 +959,8 @@ describe('create-or-update-branch tests', () => {
commitMessage,
BASE,
BRANCH,
- REMOTE_NAME
+ REMOTE_NAME,
+ false
)
expect(result.action).toEqual('created')
expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@@ -900,7 +990,8 @@ describe('create-or-update-branch tests', () => {
_commitMessage,
BASE,
BRANCH,
- REMOTE_NAME
+ REMOTE_NAME,
+ false
)
expect(_result.action).toEqual('none')
expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@@ -922,7 +1013,8 @@ describe('create-or-update-branch tests', () => {
commitMessage,
BASE,
BRANCH,
- REMOTE_NAME
+ REMOTE_NAME,
+ false
)
expect(result.action).toEqual('created')
expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@@ -960,7 +1052,8 @@ describe('create-or-update-branch tests', () => {
_commitMessage,
BASE,
BRANCH,
- REMOTE_NAME
+ REMOTE_NAME,
+ false
)
expect(_result.action).toEqual('updated')
expect(_result.hasDiffWithBase).toBeTruthy()
@@ -992,7 +1085,8 @@ describe('create-or-update-branch tests', () => {
commitMessage,
BASE,
BRANCH,
- REMOTE_NAME
+ REMOTE_NAME,
+ false
)
expect(result.action).toEqual('created')
expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@@ -1021,7 +1115,8 @@ describe('create-or-update-branch tests', () => {
_commitMessage,
BASE,
BRANCH,
- REMOTE_NAME
+ REMOTE_NAME,
+ false
)
expect(_result.action).toEqual('updated')
expect(_result.hasDiffWithBase).toBeFalsy()
@@ -1045,7 +1140,8 @@ describe('create-or-update-branch tests', () => {
commitMessage,
BASE,
BRANCH,
- REMOTE_NAME
+ REMOTE_NAME,
+ false
)
expect(result.action).toEqual('created')
expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@@ -1086,7 +1182,8 @@ describe('create-or-update-branch tests', () => {
_commitMessage,
BASE,
BRANCH,
- REMOTE_NAME
+ REMOTE_NAME,
+ false
)
expect(_result.action).toEqual('updated')
expect(_result.hasDiffWithBase).toBeFalsy()
@@ -1109,7 +1206,8 @@ describe('create-or-update-branch tests', () => {
commitMessage,
BASE,
BRANCH,
- REMOTE_NAME
+ REMOTE_NAME,
+ false
)
expect(result.action).toEqual('created')
expect(await getFileContent(TRACKED_FILE)).toEqual(commits.changes.tracked)
@@ -1141,7 +1239,8 @@ describe('create-or-update-branch tests', () => {
_commitMessage,
BASE,
BRANCH,
- REMOTE_NAME
+ REMOTE_NAME,
+ false
)
expect(_result.action).toEqual('updated')
expect(_result.hasDiffWithBase).toBeTruthy()
@@ -1168,7 +1267,8 @@ describe('create-or-update-branch tests', () => {
commitMessage,
BASE,
BRANCH,
- REMOTE_NAME
+ REMOTE_NAME,
+ false
)
expect(result.action).toEqual('created')
expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@@ -1204,7 +1304,8 @@ describe('create-or-update-branch tests', () => {
_commitMessage,
BASE,
BRANCH,
- REMOTE_NAME
+ REMOTE_NAME,
+ false
)
expect(_result.action).toEqual('updated')
expect(_result.hasDiffWithBase).toBeTruthy()
@@ -1233,7 +1334,8 @@ describe('create-or-update-branch tests', () => {
commitMessage,
BASE,
BRANCH,
- REMOTE_NAME
+ REMOTE_NAME,
+ false
)
expect(result.action).toEqual('created')
expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@@ -1277,7 +1379,8 @@ describe('create-or-update-branch tests', () => {
_commitMessage,
BASE,
BRANCH,
- REMOTE_NAME
+ REMOTE_NAME,
+ false
)
expect(_result.action).toEqual('updated')
expect(_result.hasDiffWithBase).toBeTruthy()
@@ -1305,7 +1408,8 @@ describe('create-or-update-branch tests', () => {
commitMessage,
BASE,
BRANCH,
- FORK_REMOTE_NAME
+ FORK_REMOTE_NAME,
+ false
)
expect(result.action).toEqual('created')
expect(await getFileContent(TRACKED_FILE)).toEqual(changes.tracked)
@@ -1335,7 +1439,8 @@ describe('create-or-update-branch tests', () => {
_commitMessage,
BASE,
BRANCH,
- FORK_REMOTE_NAME
+ FORK_REMOTE_NAME,
+ false
)
expect(_result.action).toEqual('updated')
expect(_result.hasDiffWithBase).toBeTruthy()
diff --git a/action.yml b/action.yml
index 36f51a2..c306a7b 100644
--- a/action.yml
+++ b/action.yml
@@ -21,6 +21,9 @@ inputs:
The author name and email address in the format `Display Name <email@address.com>`.
Defaults to the user who triggered the workflow run.
default: '${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>'
+ signoff:
+ description: 'Add `Signed-off-by` line by the committer at the end of the commit log message.'
+ default: false
branch:
description: 'The pull request branch name.'
default: 'create-pull-request/patch'
diff --git a/dist/index.js b/dist/index.js
index 550235a..687a1b3 100644
--- a/dist/index.js
+++ b/dist/index.js
@@ -1057,7 +1057,7 @@ function splitLines(multilineString) {
.map(s => s.trim())
.filter(x => x !== '');
}
-function createOrUpdateBranch(git, commitMessage, base, branch, branchRemoteName) {
+function createOrUpdateBranch(git, commitMessage, base, branch, branchRemoteName, signoff) {
return __awaiter(this, void 0, void 0, function* () {
// Get the working base. This may or may not be the actual base.
const workingBase = yield git.symbolicRef('HEAD', ['--short']);
@@ -1077,7 +1077,11 @@ function createOrUpdateBranch(git, commitMessage, base, branch, branchRemoteName
if (yield git.isDirty(true)) {
core.info('Uncommitted changes found. Adding a commit.');
yield git.exec(['add', '-A']);
- yield git.commit(['-m', commitMessage]);
+ const params = ['-m', commitMessage];
+ if (signoff) {
+ params.push('--signoff');
+ }
+ yield git.commit(params);
}
// Perform fetch and reset the working base
// Commits made during the workflow will be removed
@@ -1296,6 +1300,7 @@ function run() {
commitMessage: core.getInput('commit-message'),
committer: core.getInput('committer'),
author: core.getInput('author'),
+ signoff: core.getInput('signoff') === 'true',
branch: core.getInput('branch'),
branchSuffix: core.getInput('branch-suffix'),
base: core.getInput('base'),
@@ -10578,7 +10583,7 @@ function createPullRequest(inputs) {
core.endGroup();
// Create or update the pull request branch
core.startGroup('Create or update the pull request branch');
- const result = yield create_or_update_branch_1.createOrUpdateBranch(git, inputs.commitMessage, inputs.base, inputs.branch, branchRemoteName);
+ const result = yield create_or_update_branch_1.createOrUpdateBranch(git, inputs.commitMessage, inputs.base, inputs.branch, branchRemoteName, inputs.signoff);
core.endGroup();
if (['created', 'updated'].includes(result.action)) {
// The branch was created or updated
diff --git a/src/create-or-update-branch.ts b/src/create-or-update-branch.ts
index 9803e69..700cc14 100644
--- a/src/create-or-update-branch.ts
+++ b/src/create-or-update-branch.ts
@@ -77,7 +77,8 @@ export async function createOrUpdateBranch(
commitMessage: string,
base: string,
branch: string,
- branchRemoteName: string
+ branchRemoteName: string,
+ signoff: boolean
): Promise<CreateOrUpdateBranchResult> {
// Get the working base. This may or may not be the actual base.
const workingBase = await git.symbolicRef('HEAD', ['--short'])
@@ -99,7 +100,11 @@ export async function createOrUpdateBranch(
if (await git.isDirty(true)) {
core.info('Uncommitted changes found. Adding a commit.')
await git.exec(['add', '-A'])
- await git.commit(['-m', commitMessage])
+ const params = ['-m', commitMessage]
+ if (signoff) {
+ params.push('--signoff')
+ }
+ await git.commit(params)
}
// Perform fetch and reset the working base
diff --git a/src/create-pull-request.ts b/src/create-pull-request.ts
index 8da5f90..23e00c6 100644
--- a/src/create-pull-request.ts
+++ b/src/create-pull-request.ts
@@ -11,6 +11,7 @@ export interface Inputs {
commitMessage: string
committer: string
author: string
+ signoff: boolean
branch: string
branchSuffix: string
base: string
@@ -166,7 +167,8 @@ export async function createPullRequest(inputs: Inputs): Promise<void> {
inputs.commitMessage,
inputs.base,
inputs.branch,
- branchRemoteName
+ branchRemoteName,
+ inputs.signoff
)
core.endGroup()
diff --git a/src/main.ts b/src/main.ts
index 3fe5322..7e7b017 100644
--- a/src/main.ts
+++ b/src/main.ts
@@ -11,6 +11,7 @@ async function run(): Promise<void> {
commitMessage: core.getInput('commit-message'),
committer: core.getInput('committer'),
author: core.getInput('author'),
+ signoff: core.getInput('signoff') === 'true',
branch: core.getInput('branch'),
branchSuffix: core.getInput('branch-suffix'),
base: core.getInput('base'),