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

Update README

Browse source
This commit is contained in:
Peter Evans 2019-11-09 18:22:57 +09:00
parent 46dc4f23d5
commit 1281ebd51a
1 changed files with 54 additions and 53 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

107
README.md
View file

@ -17,54 +17,52 @@ Create Pull Request action will:
See [examples](examples.md) for detailed use cases. See [examples](examples.md) for detailed use cases.
Linux
```yml ```yml
- name: Create Pull Request - name: Create Pull Request
uses: peter-evans/create-pull-request@v1.6.1 uses: peter-evans/create-pull-request@v1.7.0
env: with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} token: ${{ secrets.GITHUB_TOKEN }}
```
Multi platform - Linux, MacOS, Windows (beta)
```yml
- name: Create Pull Request
uses: peter-evans/create-pull-request@v1.6.1-multi
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
``` ```
**Note**: If you want pull requests created by this action to trigger an `on: pull_request` workflow then you must use a [Personal Access Token](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line) instead of the default `GITHUB_TOKEN`. **Note**: If you want pull requests created by this action to trigger an `on: pull_request` workflow then you must use a [Personal Access Token](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line) instead of the default `GITHUB_TOKEN`.
See [this issue](https://github.com/peter-evans/create-pull-request/issues/48) for further details. See [this issue](https://github.com/peter-evans/create-pull-request/issues/48) for further details.
### Environment variables ### Action inputs
These variables are *all optional*. If not set, sensible default values will be used. These inputs are *all optional*. If not set, sensible default values will be used.
| Name | Description | Default | | Name | Description | Default |
| --- | --- | --- | | --- | --- | --- |
| `COMMIT_MESSAGE` | The message to use when committing changes. | `Auto-committed changes by create-pull-request action` | | `commit-message` | The message to use when committing changes. | `Auto-committed changes by create-pull-request action` |
| `COMMIT_AUTHOR_EMAIL` | The email address of the commit author. | For `push` events, the HEAD commit author. Otherwise, <GITHUB_ACTOR>@users.noreply.github.com, where `GITHUB_ACTOR` is the GitHub user that initiated the event. | | `author-email` | The email address of the commit author. | For `push` events, the HEAD commit author. Otherwise, <GITHUB_ACTOR>@users.noreply.github.com, where `GITHUB_ACTOR` is the GitHub user that initiated the event. |
| `COMMIT_AUTHOR_NAME` | The name of the commit author. | For `push` events, the HEAD commit author. Otherwise, <GITHUB_ACTOR>, the GitHub user that initiated the event. | | `author-name` | The name of the commit author. | For `push` events, the HEAD commit author. Otherwise, <GITHUB_ACTOR>, the GitHub user that initiated the event. |
| `PULL_REQUEST_TITLE` | The title of the pull request. | `Auto-generated by create-pull-request action` | | `title` | The title of the pull request. | `Auto-generated by create-pull-request action` |
| `PULL_REQUEST_BODY` | The body of the pull request. | `Auto-generated pull request by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub Action` | | `body` | The body of the pull request. | `Auto-generated pull request by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub Action` |
| `PULL_REQUEST_LABELS` | A comma separated list of labels. | none | | `labels` | A comma separated list of labels. | none |
| `PULL_REQUEST_ASSIGNEES` | A comma separated list of assignees (GitHub usernames). | none | | `assignees` | A comma separated list of assignees (GitHub usernames). | none |
| `PULL_REQUEST_REVIEWERS` | A comma separated list of reviewers (GitHub usernames) to request a review from. | none | | `reviewers` | A comma separated list of reviewers (GitHub usernames) to request a review from. | none |
| `PULL_REQUEST_TEAM_REVIEWERS` | A comma separated list of GitHub teams to request a review from. | none | | `team-reviewers` | A comma separated list of GitHub teams to request a review from. | none |
| `PULL_REQUEST_MILESTONE` | The number of the milestone to associate this pull request with. | none | | `milestone` | The number of the milestone to associate this pull request with. | none |
| `PULL_REQUEST_BRANCH` | The branch name. See **Branch naming** below for details. | `create-pull-request/patch` | | `branch` | The branch name. See **Branch naming** below for details. | `create-pull-request/patch` |
| `PULL_REQUEST_BASE` | Overrides the base branch. **Use with caution!** | Defaults to the currently checked out branch. | | `base` | Overrides the base branch. **Use with caution!** | Defaults to the currently checked out branch. |
| `BRANCH_SUFFIX` | The branch suffix type. Valid values are `short-commit-hash`, `timestamp`, `random` and `none`. See **Branch naming** below for details. | `short-commit-hash` | | `branch-suffix` | The branch suffix type. Valid values are `short-commit-hash`, `timestamp`, `random` and `none`. See **Branch naming** below for details. | `short-commit-hash` |
**Output environment variables** **Outputs**
- `PULL_REQUEST_NUMBER` - The number of the pull request created. The pull request number is output as both an environment variable and a step output.
Note that in order to read the step output the action step must have an id.
**Debug environment variables** ```yml
- name: Create Pull Request
The following parameter is available for debugging and troubleshooting. id: cpr
uses: peter-evans/create-pull-request@v1.7.0
- `DEBUG_EVENT` - If present, outputs the event data that triggered the workflow. with:
token: ${{ secrets.GITHUB_TOKEN }}
- name: Check outputs
run: |
echo "Pull Request Number - ${{ env.PULL_REQUEST_NUMBER }}"
echo "Pull Request Number - ${{ steps.cpr.outputs.pr_number }}"
```
### Branch naming ### Branch naming
@ -73,7 +71,7 @@ For branch naming there are two strategies. Always create a new branch each time
#### Strategy A - Always create a new pull request branch (default) #### Strategy A - Always create a new pull request branch (default)
For this strategy there are three options to suffix the branch name. For this strategy there are three options to suffix the branch name.
The branch name is defined by the variable `PULL_REQUEST_BRANCH` and defaults to `create-pull-request/patch`. The following options are values for `BRANCH_SUFFIX`. The branch name is defined by the input `branch` and defaults to `create-pull-request/patch`. The following options are values for `branch-suffix`.
- `short-commit-hash` (default) - Commits will be made to a branch suffixed with the short SHA1 commit hash. e.g. `create-pull-request/patch-fcdfb59`, `create-pull-request/patch-394710b` - `short-commit-hash` (default) - Commits will be made to a branch suffixed with the short SHA1 commit hash. e.g. `create-pull-request/patch-fcdfb59`, `create-pull-request/patch-394710b`
@ -83,7 +81,7 @@ The branch name is defined by the variable `PULL_REQUEST_BRANCH` and defaults to
#### Strategy B - Create and update a pull request branch #### Strategy B - Create and update a pull request branch
To use this strategy, set `BRANCH_SUFFIX` to the value `none`. The variable `PULL_REQUEST_BRANCH` defaults to `create-pull-request/patch`. Commits will be made to this branch and a pull request created. Any subsequent changes will be committed to the *same* branch and reflected in the existing pull request. To use this strategy, set `branch-suffix` to the value `none`. The input `branch` defaults to `create-pull-request/patch`. Commits will be made to this branch and a pull request created. Any subsequent changes will be committed to the *same* branch and reflected in the existing pull request.
### Ignoring files ### Ignoring files
@ -91,7 +89,7 @@ If there are files or directories you want to ignore you can simply add them to
## Reference Example ## Reference Example
The following workflow is a reference example that sets all the main environment variables. The following workflow is a reference example that sets all the main inputs.
See [examples](examples.md) for more realistic use cases. See [examples](examples.md) for more realistic use cases.
@ -106,27 +104,30 @@ jobs:
- name: Create report file - name: Create report file
run: date +%s > report.txt run: date +%s > report.txt
- name: Create Pull Request - name: Create Pull Request
uses: peter-evans/create-pull-request@v1.6.1 id: cpr
env: uses: peter-evans/create-pull-request@v1.7.0
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} with:
COMMIT_MESSAGE: Add report file token: ${{ secrets.GITHUB_TOKEN }}
COMMIT_AUTHOR_EMAIL: peter-evans@users.noreply.github.com commit-message: Add report file
COMMIT_AUTHOR_NAME: Peter Evans author-email: peter-evans@users.noreply.github.com
PULL_REQUEST_TITLE: '[Example] Add report file' author-name: Peter Evans
PULL_REQUEST_BODY: | title: '[Example] Add report file'
body: |
New report New report
- Contains *today's* date - Contains *today's* date
- Auto-generated by [create-pull-request][1] - Auto-generated by [create-pull-request][1]
[1]: https://github.com/peter-evans/create-pull-request [1]: https://github.com/peter-evans/create-pull-request
PULL_REQUEST_LABELS: report, automated pr labels: report, automated pr
PULL_REQUEST_ASSIGNEES: peter-evans assignees: peter-evans
PULL_REQUEST_REVIEWERS: peter-evans reviewers: peter-evans
PULL_REQUEST_MILESTONE: 1 milestone: 1
PULL_REQUEST_BRANCH: example-patches branch: example-patches
BRANCH_SUFFIX: short-commit-hash branch-suffix: short-commit-hash
- name: Check output environment variable - name: Check outputs
run: echo "Pull Request Number - ${{ env.PULL_REQUEST_NUMBER }}" run: |
echo "Pull Request Number - ${{ env.PULL_REQUEST_NUMBER }}"
echo "Pull Request Number - ${{ steps.cpr.outputs.pr_number }}"
``` ```
This reference configuration will create pull requests that look like this: This reference configuration will create pull requests that look like this: