From eb99d45ce6614e103b9b188ede7b279e1ec9a507 Mon Sep 17 00:00:00 2001
From: Peter Evans <peter-evans@users.noreply.github.com>
Date: Wed, 1 Apr 2020 18:50:53 +0900
Subject: [PATCH] Default token to github.token
---
.github/workflows/cpr-example-command.yml | 1 -
README.md | 13 +++----------
action.yml | 2 +-
docs/concepts-guidelines.md | 9 ---------
docs/examples.md | 8 --------
5 files changed, 4 insertions(+), 29 deletions(-)
diff --git a/.github/workflows/cpr-example-command.yml b/.github/workflows/cpr-example-command.yml
index dcf8d2a..f050cb9 100644
--- a/.github/workflows/cpr-example-command.yml
+++ b/.github/workflows/cpr-example-command.yml
@@ -13,7 +13,6 @@ jobs:
id: cpr
uses: ./
with:
- token: ${{ secrets.GITHUB_TOKEN }}
commit-message: Add report file
committer: Peter Evans <peter-evans@users.noreply.github.com>
title: '[Example] Add report file'
diff --git a/README.md b/README.md
index 6deba6a..249c4ed 100644
--- a/README.md
+++ b/README.md
@@ -27,22 +27,20 @@ Create Pull Request action will:
```yml
- name: Create Pull Request
uses: peter-evans/create-pull-request@v2
- with:
- token: ${{ secrets.GITHUB_TOKEN }}
```
You can also pin to a [specific release](https://github.com/peter-evans/create-pull-request/releases) version in the format `@v2.x.x`
### Action inputs
-With the exception of `token`, all inputs are **optional**. If not set, sensible default values will be used.
+All inputs are **optional**. If not set, sensible default values will be used.
**Note**: If you want pull requests created by this action to trigger an `on: push` or `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`. Alternatively, allow the action to [push using SSH](https://github.com/peter-evans/create-pull-request/blob/master/docs/concepts-guidelines.md#push-using-ssh-deploy-keys) by configuring a deploy key.
| Name | Description | Default |
| --- | --- | --- |
-| `token` | `GITHUB_TOKEN` or a `repo` scoped [PAT](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line). | |
-| `path` | Relative path under `$GITHUB_WORKSPACE` to the repository. | `$GITHUB_WORKSPACE` |
+| `token` | `GITHUB_TOKEN` or a `repo` scoped [PAT](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line). | `GITHUB_TOKEN` |
+| `path` | Relative path under `GITHUB_WORKSPACE` to the repository. | `GITHUB_WORKSPACE` |
| `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. See [Committer and author](#committer-and-author) for details. |
| `author` | The author name and email address in the format `Display Name <email@address.com>`. | Defaults to the GitHub Actions bot user. See [Committer and author](#committer-and-author) for details. |
@@ -69,8 +67,6 @@ Note that in order to read the step output the action step must have an id.
- name: Create Pull Request
id: cpr
uses: peter-evans/create-pull-request@v2
- with:
- token: ${{ secrets.GITHUB_TOKEN }}
- name: Check outputs
run: |
echo "Pull Request Number - ${{ env.PULL_REQUEST_NUMBER }}"
@@ -120,7 +116,6 @@ In most cases, where the committer and author are the same, just the committer c
- name: Create Pull Request
uses: peter-evans/create-pull-request@v2
with:
- token: ${{ secrets.GITHUB_TOKEN }}
committer: Peter Evans <peter-evans@users.noreply.github.com>
```
@@ -144,8 +139,6 @@ As well as relying on the action to handle uncommitted changes, you can addition
run: date +%s > report.txt
- name: Create Pull Request
uses: peter-evans/create-pull-request@v2
- with:
- token: ${{ secrets.GITHUB_TOKEN }}
```
## Reference Example
diff --git a/action.yml b/action.yml
index ecbb65e..f4483f6 100644
--- a/action.yml
+++ b/action.yml
@@ -3,7 +3,7 @@ description: 'Creates a pull request for changes to your repository in the actio
inputs:
token:
description: 'GITHUB_TOKEN or a repo scoped PAT'
- required: true
+ default: ${{ github.token }}
path:
description: 'Relative path under $GITHUB_WORKSPACE to the repository.'
commit-message:
diff --git a/docs/concepts-guidelines.md b/docs/concepts-guidelines.md
index 92a9c34..dd40f90 100644
--- a/docs/concepts-guidelines.md
+++ b/docs/concepts-guidelines.md
@@ -177,8 +177,6 @@ How to use SSH (deploy keys) with create-pull-request action:
- name: Create Pull Request
uses: peter-evans/create-pull-request@v2
- with:
- token: ${{ secrets.GITHUB_TOKEN }}
```
### Push pull request branches to a fork
@@ -236,8 +234,6 @@ jobs:
- name: Create Pull Request
uses: peter-evans/create-pull-request@v2
- with:
- token: ${{ secrets.GITHUB_TOKEN }}
```
**Ubuntu container example:**
@@ -261,8 +257,6 @@ jobs:
- name: Create Pull Request
uses: peter-evans/create-pull-request@v2
- with:
- token: ${{ secrets.GITHUB_TOKEN }}
```
### Creating pull requests on tag push
@@ -296,7 +290,6 @@ jobs:
- name: Create Pull Request
uses: peter-evans/create-pull-request@v2
with:
- token: ${{ secrets.GITHUB_TOKEN }}
base: master
- name: Delete tag branch
@@ -324,6 +317,4 @@ jobs:
- name: Create Pull Request
uses: peter-evans/create-pull-request@v2
- with:
- token: ${{ secrets.GITHUB_TOKEN }}
```
diff --git a/docs/examples.md b/docs/examples.md
index 3eb788a..ff1386a 100644
--- a/docs/examples.md
+++ b/docs/examples.md
@@ -45,7 +45,6 @@ jobs:
- name: Create Pull Request
uses: peter-evans/create-pull-request@v2
with:
- token: ${{ secrets.GITHUB_TOKEN }}
commit-message: update authors
title: Update AUTHORS
body: Credit new contributors by updating AUTHORS
@@ -78,7 +77,6 @@ jobs:
- name: Create Pull Request
uses: peter-evans/create-pull-request@v2
with:
- token: ${{ secrets.GITHUB_TOKEN }}
branch: production-promotion
```
@@ -110,7 +108,6 @@ jobs:
- name: Create Pull Request
uses: peter-evans/create-pull-request@v2
with:
- token: ${{ secrets.GITHUB_TOKEN }}
commit-message: update dependencies
title: Automated Dependency Updates
body: This is an auto-generated PR with dependency updates.
@@ -161,7 +158,6 @@ jobs:
- name: Create Pull Request
uses: peter-evans/create-pull-request@v2
with:
- token: ${{ secrets.GITHUB_TOKEN }}
commit-message: Update swagger-ui to ${{ steps.swagger-ui.outputs.release_tag }}
title: Update SwaggerUI to ${{ steps.swagger-ui.outputs.release_tag }}
body: |
@@ -204,7 +200,6 @@ jobs:
- name: Create Pull Request
uses: peter-evans/create-pull-request@v2
with:
- token: ${{ secrets.GITHUB_TOKEN }}
commit-message: update local website copy
title: Automated Updates to Local Website Copy
body: This is an auto-generated PR with website updates.
@@ -299,7 +294,6 @@ jobs:
if: steps.autopep8.outputs.exit-code == 2
uses: peter-evans/create-pull-request@v2
with:
- token: ${{ secrets.GITHUB_TOKEN }}
commit-message: autopep8 action fixes
title: Fixes by autopep8 action
body: This is an auto-generated PR with fixes by autopep8.
@@ -358,7 +352,6 @@ The recommended method is to use [`set-output`](https://help.github.com/en/githu
- name: Create Pull Request
uses: peter-evans/create-pull-request@v2
with:
- token: ${{ secrets.GITHUB_TOKEN }}
title: ${{ steps.vars.outputs.pr_title }}
body: ${{ steps.vars.outputs.pr_body }}
```
@@ -374,7 +367,6 @@ Alternatively, [`set-env`](https://help.github.com/en/github/automating-your-wor
- name: Create Pull Request
uses: peter-evans/create-pull-request@v2
with:
- token: ${{ secrets.GITHUB_TOKEN }}
title: ${{ env.PULL_REQUEST_TITLE }}
body: ${{ env.PULL_REQUEST_BODY }}
```