From 16354377ad7d416480be2ebc011de8c3858fac53 Mon Sep 17 00:00:00 2001 From: Peter Evans Date: Sun, 19 Jul 2020 17:04:47 +0900 Subject: [PATCH] Update documentation --- README.md | 8 ++++---- docs/concepts-guidelines.md | 16 ++++++++-------- docs/examples.md | 18 +++++++++--------- 3 files changed, 21 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 8ecc742..5a3054e 100644 --- a/README.md +++ b/README.md @@ -65,7 +65,7 @@ Note that in order to read the step output the action step must have an id. ```yml - name: Create Pull Request id: cpr - uses: peter-evans/create-pull-request@v2 + uses: peter-evans/create-pull-request@v3 - name: Check outputs run: | echo "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}" @@ -104,7 +104,7 @@ If neither `committer` or `author` inputs are supplied the action will look for The following configuration can be used to have commits authored by the user who triggered the workflow event. ```yml - name: Create Pull Request - uses: peter-evans/create-pull-request@v2 + uses: peter-evans/create-pull-request@v3 with: committer: GitHub author: ${{ github.actor }} <${{ github.actor }}@users.noreply.github.com> @@ -129,7 +129,7 @@ As well as relying on the action to handle uncommitted changes, you can addition - name: Uncommitted change run: date +%s > report.txt - name: Create Pull Request - uses: peter-evans/create-pull-request@v2 + uses: peter-evans/create-pull-request@v3 ``` ### Ignoring files @@ -143,7 +143,7 @@ To create a project card for the pull request, pass the `pull-request-number` st ```yml - name: Create Pull Request id: cpr - uses: peter-evans/create-pull-request@v2 + uses: peter-evans/create-pull-request@v3 - name: Create or Update Project Card uses: peter-evans/create-or-update-project-card@v1 diff --git a/docs/concepts-guidelines.md b/docs/concepts-guidelines.md index 808336e..806bfea 100644 --- a/docs/concepts-guidelines.md +++ b/docs/concepts-guidelines.md @@ -159,7 +159,7 @@ Checking out a branch from a different repository from where the workflow is exe # Make changes to pull request here - - uses: peter-evans/create-pull-request@v2 + - uses: peter-evans/create-pull-request@v3 with: token: ${{ secrets.PAT }} ``` @@ -185,7 +185,7 @@ How to use SSH (deploy keys) with create-pull-request action: # Make changes to pull request here - name: Create Pull Request - uses: peter-evans/create-pull-request@v2 + uses: peter-evans/create-pull-request@v3 ``` ### Push pull request branches to a fork @@ -207,7 +207,7 @@ It will use their own fork to push code and create the pull request. # Make changes to pull request here - - uses: peter-evans/create-pull-request@v2 + - uses: peter-evans/create-pull-request@v3 with: token: ${{ secrets.MACHINE_USER_PAT }} push-to-fork: machine-user/fork-of-repository @@ -248,7 +248,7 @@ GitHub App generated tokens are more secure than using a PAT because GitHub App # Make changes to pull request here - name: Create Pull Request - uses: peter-evans/create-pull-request@v2 + uses: peter-evans/create-pull-request@v3 with: token: ${{ steps.generate-token.outputs.token }} ``` @@ -277,7 +277,7 @@ jobs: # Make changes to pull request here - name: Create Pull Request - uses: peter-evans/create-pull-request@v2 + uses: peter-evans/create-pull-request@v3 ``` **Ubuntu container example:** @@ -300,7 +300,7 @@ jobs: # Make changes to pull request here - name: Create Pull Request - uses: peter-evans/create-pull-request@v2 + uses: peter-evans/create-pull-request@v3 ``` ### Creating pull requests on tag push @@ -332,7 +332,7 @@ jobs: # Make changes to pull request here - name: Create Pull Request - uses: peter-evans/create-pull-request@v2 + uses: peter-evans/create-pull-request@v3 with: base: master @@ -360,5 +360,5 @@ jobs: # Make changes to pull request here - name: Create Pull Request - uses: peter-evans/create-pull-request@v2 + uses: peter-evans/create-pull-request@v3 ``` diff --git a/docs/examples.md b/docs/examples.md index 6e5732e..a24c09e 100644 --- a/docs/examples.md +++ b/docs/examples.md @@ -44,7 +44,7 @@ jobs: run: | git log --format='%aN <%aE>%n%cN <%cE>' | sort -u > AUTHORS - name: Create Pull Request - uses: peter-evans/create-pull-request@v2 + uses: peter-evans/create-pull-request@v3 with: commit-message: update authors title: Update AUTHORS @@ -76,7 +76,7 @@ jobs: git fetch origin master:master git reset --hard master - name: Create Pull Request - uses: peter-evans/create-pull-request@v2 + uses: peter-evans/create-pull-request@v3 with: branch: production-promotion ``` @@ -109,7 +109,7 @@ jobs: npx -p npm-check-updates ncu -u npm install - name: Create Pull Request - uses: peter-evans/create-pull-request@v2 + uses: peter-evans/create-pull-request@v3 with: token: ${{ secrets.PAT }} commit-message: Update dependencies @@ -169,7 +169,7 @@ jobs: - name: Perform dependency resolution and write new lockfiles run: ./gradlew dependencies --write-locks - name: Create Pull Request - uses: peter-evans/create-pull-request@v2 + uses: peter-evans/create-pull-request@v3 with: token: ${{ secrets.PAT }} commit-message: Update dependencies @@ -225,7 +225,7 @@ jobs: # Update current release echo ${{ steps.swagger-ui.outputs.release_tag }} > swagger-ui.version - name: Create Pull Request - uses: peter-evans/create-pull-request@v2 + uses: peter-evans/create-pull-request@v3 with: commit-message: Update swagger-ui to ${{ steps.swagger-ui.outputs.release_tag }} title: Update SwaggerUI to ${{ steps.swagger-ui.outputs.release_tag }} @@ -267,7 +267,7 @@ jobs: --domains quotes.toscrape.com \ http://quotes.toscrape.com/ - name: Create Pull Request - uses: peter-evans/create-pull-request@v2 + uses: peter-evans/create-pull-request@v3 with: commit-message: update local website copy title: Automated Updates to Local Website Copy @@ -361,7 +361,7 @@ jobs: run: echo ::set-output name=branch-name::"autopep8-patches/${{ github.head_ref }}" - name: Create Pull Request if: steps.autopep8.outputs.exit-code == 2 - uses: peter-evans/create-pull-request@v2 + uses: peter-evans/create-pull-request@v3 with: commit-message: autopep8 action fixes title: Fixes by autopep8 action @@ -419,7 +419,7 @@ The recommended method is to use [`set-output`](https://help.github.com/en/githu echo ::set-output name=pr_body::"This PR was auto-generated on $(date +%d-%m-%Y) \ by [create-pull-request](https://github.com/peter-evans/create-pull-request)." - name: Create Pull Request - uses: peter-evans/create-pull-request@v2 + uses: peter-evans/create-pull-request@v3 with: title: ${{ steps.vars.outputs.pr_title }} body: ${{ steps.vars.outputs.pr_body }} @@ -434,7 +434,7 @@ Alternatively, [`set-env`](https://help.github.com/en/github/automating-your-wor echo ::set-env name=PULL_REQUEST_BODY::"This PR was auto-generated on $(date +%d-%m-%Y) \ by [create-pull-request](https://github.com/peter-evans/create-pull-request)." - name: Create Pull Request - uses: peter-evans/create-pull-request@v2 + uses: peter-evans/create-pull-request@v3 with: title: ${{ env.PULL_REQUEST_TITLE }} body: ${{ env.PULL_REQUEST_BODY }}