jiriks74/create-pull-request
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Merge pull request #476 from pvogt09/master

Browse source 
Adds option to signoff commits
This commit is contained in:
Peter Evans 2020-07-31 15:12:43 +09:00 committed by GitHub
commit bf7dd38b26
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 110 additions and 50 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
README.md
View file

@ -57,6 +57,7 @@ All inputs are **optional**. If not set, sensible defaults will be used.
| `team-reviewers` | A comma or newline separated list of GitHub teams to request a review from. Note that a `repo` scoped [PAT](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line) may be required. See [this issue](https://github.com/peter-evans/create-pull-request/issues/155). | |
| `milestone` | The number of the milestone to associate this pull request with. | |
| `draft` | Create a [draft pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests#draft-pull-requests). | `false` |
| `signoff` | Add Signed-off-by to commit message | `false` |
### Action outputs

126
__test__/create-or-update-branch.int.test.ts
View file

@ -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()
@ -748,7 +769,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 +788,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 +818,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 +841,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 +871,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 +896,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 +927,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 +950,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 +989,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 +1022,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 +1052,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 +1077,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 +1119,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 +1143,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 +1176,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 +1204,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 +1241,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 +1271,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 +1316,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 +1345,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 +1376,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()

3
action.yml
View file

@ -56,6 +56,9 @@ inputs:
draft:
description: 'Create a draft pull request'
default: false
signoff:
description: 'Add "Signed-off-by" to commit message'
default: false
outputs:
pull-request-number:
description: 'The pull request number'

14
dist/index.js vendored
View file

@ -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,12 @@ 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]);
if (signoff == true) {
yield git.commit(['-m', commitMessage, '-s']);
}
else {
yield git.commit(['-m', commitMessage]);
}
}
// Perform fetch and reset the working base
// Commits made during the workflow will be removed
@ -1307,7 +1312,8 @@ function run() {
reviewers: utils.getInputAsArray('reviewers'),
teamReviewers: utils.getInputAsArray('team-reviewers'),
milestone: Number(core.getInput('milestone')),
draft: core.getInput('draft') === 'true'
draft: core.getInput('draft') === 'true',
signoff: core.getInput('signoff') === 'true'
};
core.debug(`Inputs: ${util_1.inspect(inputs)}`);
yield create_pull_request_1.createPullRequest(inputs);
@ -10578,7 +10584,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

9
src/create-or-update-branch.ts
View file

@ -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])
if (signoff == true) {
await git.commit(['-m', commitMessage, '-s'])
} else {
await git.commit(['-m', commitMessage])
}
}
// Perform fetch and reset the working base

4
src/create-pull-request.ts
View file

@ -23,6 +23,7 @@ export interface Inputs {
teamReviewers: string[]
milestone: number
draft: boolean
signoff: boolean
}
export async function createPullRequest(inputs: Inputs): Promise<void> {
@ -166,7 +167,8 @@ export async function createPullRequest(inputs: Inputs): Promise<void> {
inputs.commitMessage,
inputs.base,
inputs.branch,
branchRemoteName
branchRemoteName,
inputs.signoff
)
core.endGroup()

3
src/main.ts
View file

@ -22,7 +22,8 @@ async function run(): Promise<void> {
reviewers: utils.getInputAsArray('reviewers'),
teamReviewers: utils.getInputAsArray('team-reviewers'),
milestone: Number(core.getInput('milestone')),
draft: core.getInput('draft') === 'true'
draft: core.getInput('draft') === 'true',
signoff: core.getInput('signoff') === 'true'
}
core.debug(`Inputs: ${inspect(inputs)}`)