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

docs: update to checkout v4

Browse source
This commit is contained in:
Peter Evans 2023-10-31 15:33:41 +00:00
parent 2f092153d6
commit 76c6f5c20e
3 changed files with 24 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -174,7 +174,7 @@ Note that the repository must be checked out on a branch with a remote, it won't
```yml ```yml
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v4
- name: Create commits - name: Create commits
run: | run: |
git config user.name 'Peter Evans' git config user.name 'Peter Evans'
@ -225,7 +225,7 @@ jobs:
createPullRequest: createPullRequest:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v4
- name: Make changes to pull request - name: Make changes to pull request
run: date +%s > report.txt run: date +%s > report.txt

18
docs/concepts-guidelines.md
View file

@ -36,7 +36,7 @@ For each [event type](https://docs.github.com/en/actions/reference/events-that-t
The default can be overridden by specifying a `ref` on checkout. The default can be overridden by specifying a `ref` on checkout.
```yml ```yml
- uses: actions/checkout@v3 - uses: actions/checkout@v4
with: with:
ref: develop ref: develop
``` ```
@ -73,7 +73,7 @@ jobs:
example: example:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v4
``` ```
There may be use cases where it makes sense to execute the workflow on a branch that is not the base of the pull request. In these cases, the base branch can be specified with the `base` action input. The action will attempt to rebase changes made during the workflow on to the actual base. There may be use cases where it makes sense to execute the workflow on a branch that is not the base of the pull request. In these cases, the base branch can be specified with the `base` action input. The action will attempt to rebase changes made during the workflow on to the actual base.
@ -173,7 +173,7 @@ This action uses [ncc](https://github.com/vercel/ncc) to compile the Node.js cod
Checking out a branch from a different repository from where the workflow is executing will make *that repository* the target for the created pull request. In this case, a `repo` scoped [Personal Access Token (PAT)](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) is required. Checking out a branch from a different repository from where the workflow is executing will make *that repository* the target for the created pull request. In this case, a `repo` scoped [Personal Access Token (PAT)](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) is required.
```yml ```yml
- uses: actions/checkout@v3 - uses: actions/checkout@v4
with: with:
token: ${{ secrets.PAT }} token: ${{ secrets.PAT }}
repository: owner/repo repository: owner/repo
@ -200,7 +200,7 @@ How to use SSH (deploy keys) with create-pull-request action:
```yml ```yml
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v4
with: with:
ssh-key: ${{ secrets.SSH_PRIVATE_KEY }} ssh-key: ${{ secrets.SSH_PRIVATE_KEY }}
@ -226,7 +226,7 @@ Note that if you choose to use this method (not give the machine account `write`
6. As shown in the following example workflow, set the `push-to-fork` input to the full repository name of the fork. 6. As shown in the following example workflow, set the `push-to-fork` input to the full repository name of the fork.
```yaml ```yaml
- uses: actions/checkout@v3 - uses: actions/checkout@v4
# Make changes to pull request here # Make changes to pull request here
@ -264,7 +264,7 @@ GitHub App generated tokens are more secure than using a PAT because GitHub App
```yaml ```yaml
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v4
- uses: tibdex/github-app-token@v1 - uses: tibdex/github-app-token@v1
id: generate-token id: generate-token
@ -304,7 +304,7 @@ The action can use GPG to sign commits with a GPG key that you generate yourself
```yaml ```yaml
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v4
- uses: crazy-max/ghaction-import-gpg@v5 - uses: crazy-max/ghaction-import-gpg@v5
with: with:
@ -341,7 +341,7 @@ jobs:
- name: Install dependencies - name: Install dependencies
run: apk --no-cache add git run: apk --no-cache add git
- uses: actions/checkout@v3 - uses: actions/checkout@v4
# Make changes to pull request here # Make changes to pull request here
@ -364,7 +364,7 @@ jobs:
add-apt-repository -y ppa:git-core/ppa add-apt-repository -y ppa:git-core/ppa
apt-get install -y git apt-get install -y git
- uses: actions/checkout@v3 - uses: actions/checkout@v4
# Make changes to pull request here # Make changes to pull request here

26
docs/examples.md
View file

@ -43,7 +43,7 @@ jobs:
updateAuthors: updateAuthors:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v4
with: with:
fetch-depth: 0 fetch-depth: 0
- name: Update AUTHORS - name: Update AUTHORS
@ -74,7 +74,7 @@ jobs:
productionPromotion: productionPromotion:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v4
with: with:
ref: production ref: production
- name: Reset promotion branch - name: Reset promotion branch
@ -107,7 +107,7 @@ jobs:
updateChangelog: updateChangelog:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v4
with: with:
fetch-depth: 0 fetch-depth: 0
- name: Update Changelog - name: Update Changelog
@ -145,7 +145,7 @@ jobs:
update-dep: update-dep:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v4
- uses: actions/setup-node@v3 - uses: actions/setup-node@v3
with: with:
node-version: '16.x' node-version: '16.x'
@ -181,7 +181,7 @@ jobs:
build: build:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v4
- uses: actions/setup-node@v3 - uses: actions/setup-node@v3
with: with:
node-version: 16.x node-version: 16.x
@ -205,7 +205,7 @@ jobs:
update-dep: update-dep:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v4
- uses: actions/setup-java@v2 - uses: actions/setup-java@v2
with: with:
distribution: 'temurin' distribution: 'temurin'
@ -243,7 +243,7 @@ jobs:
update-dep: update-dep:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v4
- name: Update dependencies - name: Update dependencies
run: | run: |
cargo install cargo-edit cargo install cargo-edit
@ -278,7 +278,7 @@ jobs:
updateSwagger: updateSwagger:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v4
- name: Get Latest Swagger UI Release - name: Get Latest Swagger UI Release
id: swagger-ui id: swagger-ui
run: | run: |
@ -343,7 +343,7 @@ jobs:
updateFork: updateFork:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v4
with: with:
repository: fork-owner/repo repository: fork-owner/repo
- name: Reset the default branch with upstream changes - name: Reset the default branch with upstream changes
@ -371,7 +371,7 @@ jobs:
format: format:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v4
- name: Download website - name: Download website
run: | run: |
wget \ wget \
@ -467,7 +467,7 @@ jobs:
if: startsWith(github.head_ref, 'autopep8-patches') == false && github.event.pull_request.head.repo.full_name == github.repository if: startsWith(github.head_ref, 'autopep8-patches') == false && github.event.pull_request.head.repo.full_name == github.repository
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v4
with: with:
ref: ${{ github.head_ref }} ref: ${{ github.head_ref }}
- name: autopep8 - name: autopep8
@ -516,13 +516,13 @@ jobs:
if: startsWith(github.ref, 'refs/heads/') if: startsWith(github.ref, 'refs/heads/')
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v4
... ...
someOtherJob: someOtherJob:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v4
... ...
``` ```