create-pull-request/action.yml

76 lines
2.9 KiB
YAML
Raw Normal View History

2019-10-02 12:20:07 +02:00
name: 'Create Pull Request'
description: 'Creates a pull request for changes to your repository in the actions workspace'
2019-11-09 09:24:47 +01:00
inputs:
token:
2020-07-19 08:09:44 +02:00
description: 'GITHUB_TOKEN or a `repo` scoped Personal Access Token (PAT)'
2020-04-01 11:50:53 +02:00
default: ${{ github.token }}
2020-01-09 16:11:39 +01:00
path:
2020-07-19 08:09:44 +02:00
description: >
Relative path under $GITHUB_WORKSPACE to the repository.
Defaults to $GITHUB_WORKSPACE.
2019-11-09 09:24:47 +01:00
commit-message:
description: 'The message to use when committing changes.'
2020-07-19 08:09:44 +02:00
default: '[create-pull-request] automated change'
2019-12-27 06:40:08 +01:00
committer:
2020-07-19 08:09:44 +02:00
description: >
The committer name and email address in the format `Display Name <email@address.com>`.
Defaults to the GitHub Actions bot user.
default: 'GitHub <noreply@github.com>'
2019-12-27 06:40:08 +01:00
author:
2020-07-19 08:09:44 +02:00
description: >
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
2020-07-19 08:09:44 +02:00
branch:
description: 'The pull request branch name.'
default: 'create-pull-request/patch'
2020-09-06 03:21:35 +02:00
delete-branch:
description: >
Delete the `branch` when closing pull requests, and when undeleted after merging.
Recommend `true`.
default: false
2020-07-20 12:14:42 +02:00
branch-suffix:
description: 'The branch suffix type when using the alternative branching strategy.'
2020-07-19 08:09:44 +02:00
base:
description: >
The pull request base branch.
Defaults to the branch checked out in the workflow.
push-to-fork:
description: >
A fork of the checked out parent repository to which the pull request branch will be pushed.
2020-07-19 10:01:54 +02:00
e.g. `owner/repo-fork`.
2020-07-19 08:09:44 +02:00
The pull request will be created to merge the fork's branch into the parent's base.
2019-11-09 09:24:47 +01:00
title:
description: 'The title of the pull request.'
2020-07-19 08:09:44 +02:00
default: 'Changes by create-pull-request action'
2019-11-09 09:24:47 +01:00
body:
description: 'The body of the pull request.'
2020-07-19 08:09:44 +02:00
default: 'Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action'
2019-11-09 09:24:47 +01:00
labels:
2020-07-19 08:09:44 +02:00
description: 'A comma or newline separated list of labels.'
2019-11-09 09:24:47 +01:00
assignees:
2020-07-19 08:09:44 +02:00
description: 'A comma or newline separated list of assignees (GitHub usernames).'
2019-11-09 09:24:47 +01:00
reviewers:
2020-07-19 08:09:44 +02:00
description: 'A comma or newline separated list of reviewers (GitHub usernames) to request a review from.'
2019-11-09 09:24:47 +01:00
team-reviewers:
2020-07-19 10:01:54 +02:00
description: >
A comma or newline separated list of GitHub teams to request a review from.
Note that a `repo` scoped Personal Access Token (PAT) may be required.
2019-11-09 09:24:47 +01:00
milestone:
2020-07-19 08:09:44 +02:00
description: 'The number of the milestone to associate the pull request with.'
2020-05-17 10:47:54 +02:00
draft:
description: 'Create a draft pull request'
2020-07-19 08:09:44 +02:00
default: false
2019-11-10 05:07:11 +01:00
outputs:
2020-05-10 11:06:32 +02:00
pull-request-number:
2019-11-10 05:07:11 +01:00
description: 'The pull request number'
2019-10-02 12:20:07 +02:00
runs:
2019-11-09 09:24:47 +01:00
using: 'node12'
main: 'dist/index.js'
2019-10-02 12:20:07 +02:00
branding:
2020-03-27 18:56:55 +01:00
icon: 'git-pull-request'
2019-10-02 12:20:07 +02:00
color: 'gray-dark'