Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions docs/concepts-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,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.

```yml
- uses: actions/checkout@v4
- uses: actions/checkout@v6
with:
ref: develop
```
Expand Down Expand Up @@ -77,7 +77,7 @@ jobs:
example:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v6
```

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.
Expand Down Expand Up @@ -179,7 +179,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, the `GITHUB_TOKEN` will not work and one of the other [token options](../README.md#token) must be used.

```yml
- uses: actions/checkout@v4
- uses: actions/checkout@v6
with:
token: ${{ secrets.PAT }}
repository: owner/repo
Expand Down Expand Up @@ -210,7 +210,7 @@ How to use SSH (deploy keys) with create-pull-request action:

```yml
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v6
with:
ssh-key: ${{ secrets.SSH_PRIVATE_KEY }}

Expand Down Expand Up @@ -238,7 +238,7 @@ It will use their own fork to push code and create the pull request.
6. As shown in the following example workflow, set the `push-to-fork` input to the full repository name of the fork.

```yaml
- uses: actions/checkout@v4
- uses: actions/checkout@v6

# Make changes to pull request here

Expand Down Expand Up @@ -280,7 +280,7 @@ The following is an example of pushing to a fork using GitHub App tokens.
owner: owner
repositories: fork-of-repo

- uses: actions/checkout@v4
- uses: actions/checkout@v6

# Make changes to pull request here

Expand Down Expand Up @@ -325,7 +325,7 @@ GitHub App generated tokens can be configured with fine-grained permissions and
app-id: ${{ secrets.APP_ID }}
private-key: ${{ secrets.APP_PRIVATE_KEY }}

- uses: actions/checkout@v4
- uses: actions/checkout@v6

# Make changes to pull request here

Expand All @@ -350,7 +350,7 @@ In the following example, a pull request is being created in remote repo `owner/
owner: owner
repositories: repo

- uses: actions/checkout@v4
- uses: actions/checkout@v6
with:
token: ${{ steps.generate-token.outputs.token }} # necessary if the repo is private
repository: owner/repo
Expand Down Expand Up @@ -382,7 +382,7 @@ The action can sign commits as `github-actions[bot]` when using the repository's
In this example the `token` input is not supplied, so the action will use the repository's default `GITHUB_TOKEN`. This will sign commits as `github-actions[bot]`.
```yaml
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v6

# Make changes to pull request here

Expand All @@ -395,7 +395,7 @@ In this example the `token` input is not supplied, so the action will use the re
In this example, the `token` input is generated using a GitHub App. This will sign commits as `<application-name>[bot]`.
```yaml
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v6

- uses: actions/create-github-app-token@v2
id: generate-token
Expand Down Expand Up @@ -437,7 +437,7 @@ The action can use GPG to sign commits with a GPG key that you generate yourself

```yaml
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v6

- uses: crazy-max/ghaction-import-gpg@v5
with:
Expand Down Expand Up @@ -474,7 +474,7 @@ jobs:
- name: Install dependencies
run: apk --no-cache add git

- uses: actions/checkout@v4
- uses: actions/checkout@v6

# Make changes to pull request here

Expand All @@ -497,7 +497,7 @@ jobs:
add-apt-repository -y ppa:git-core/ppa
apt-get install -y git

- uses: actions/checkout@v4
- uses: actions/checkout@v6

# Make changes to pull request here

Expand Down
26 changes: 13 additions & 13 deletions docs/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ jobs:
updateAuthors:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v6
with:
fetch-depth: 0
- name: Update AUTHORS
Expand Down Expand Up @@ -73,7 +73,7 @@ jobs:
productionPromotion:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v6
with:
ref: production
- name: Reset promotion branch
Expand Down Expand Up @@ -106,7 +106,7 @@ jobs:
updateChangelog:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v6
with:
fetch-depth: 0
- name: Update Changelog
Expand Down Expand Up @@ -144,7 +144,7 @@ jobs:
update-dep:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v6
- uses: actions/setup-node@v3
with:
node-version: '16.x'
Expand Down Expand Up @@ -180,7 +180,7 @@ jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v6
- uses: actions/setup-node@v3
with:
node-version: 16.x
Expand All @@ -204,7 +204,7 @@ jobs:
update-dep:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v6
- uses: actions/setup-java@v2
with:
distribution: 'temurin'
Expand Down Expand Up @@ -242,7 +242,7 @@ jobs:
update-dep:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v6
- name: Update dependencies
run: |
cargo install cargo-edit
Expand Down Expand Up @@ -277,7 +277,7 @@ jobs:
updateSwagger:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v6
- name: Get Latest Swagger UI Release
id: swagger-ui
run: |
Expand Down Expand Up @@ -342,7 +342,7 @@ jobs:
updateFork:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v6
with:
repository: fork-owner/repo
- name: Reset the default branch with upstream changes
Expand Down Expand Up @@ -370,7 +370,7 @@ jobs:
format:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v6
- name: Download website
run: |
wget \
Expand Down Expand Up @@ -466,7 +466,7 @@ jobs:
if: startsWith(github.head_ref, 'autopep8-patches') == false && github.event.pull_request.head.repo.full_name == github.repository
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v6
with:
ref: ${{ github.head_ref }}
- name: autopep8
Expand Down Expand Up @@ -515,13 +515,13 @@ jobs:
if: startsWith(github.ref, 'refs/heads/')
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v6
...

someOtherJob:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v6
...
```

Expand Down