|
|
|
|
@ -51,7 +51,7 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
|
|
|
|
|
|
|
|
|
|
<!-- start usage -->
|
|
|
|
|
```yaml
|
|
|
|
|
- uses: actions/checkout@v5
|
|
|
|
|
- uses: actions/checkout@v6
|
|
|
|
|
with:
|
|
|
|
|
# Repository name with owner. For example, actions/checkout
|
|
|
|
|
# Default: ${{ github.repository }}
|
|
|
|
|
@ -190,7 +190,7 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
|
|
|
|
|
## Fetch only the root files
|
|
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
|
- uses: actions/checkout@v5
|
|
|
|
|
- uses: actions/checkout@v6
|
|
|
|
|
with:
|
|
|
|
|
sparse-checkout: .
|
|
|
|
|
```
|
|
|
|
|
@ -198,7 +198,7 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
|
|
|
|
|
## Fetch only the root files and `.github` and `src` folder
|
|
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
|
- uses: actions/checkout@v5
|
|
|
|
|
- uses: actions/checkout@v6
|
|
|
|
|
with:
|
|
|
|
|
sparse-checkout: |
|
|
|
|
|
.github
|
|
|
|
|
@ -208,7 +208,7 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
|
|
|
|
|
## Fetch only a single file
|
|
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
|
- uses: actions/checkout@v5
|
|
|
|
|
- uses: actions/checkout@v6
|
|
|
|
|
with:
|
|
|
|
|
sparse-checkout: |
|
|
|
|
|
README.md
|
|
|
|
|
@ -218,7 +218,7 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
|
|
|
|
|
## Fetch all history for all tags and branches
|
|
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
|
- uses: actions/checkout@v5
|
|
|
|
|
- uses: actions/checkout@v6
|
|
|
|
|
with:
|
|
|
|
|
fetch-depth: 0
|
|
|
|
|
```
|
|
|
|
|
@ -226,7 +226,7 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
|
|
|
|
|
## Checkout a different branch
|
|
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
|
- uses: actions/checkout@v5
|
|
|
|
|
- uses: actions/checkout@v6
|
|
|
|
|
with:
|
|
|
|
|
ref: my-branch
|
|
|
|
|
```
|
|
|
|
|
@ -234,7 +234,7 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
|
|
|
|
|
## Checkout HEAD^
|
|
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
|
- uses: actions/checkout@v5
|
|
|
|
|
- uses: actions/checkout@v6
|
|
|
|
|
with:
|
|
|
|
|
fetch-depth: 2
|
|
|
|
|
- run: git checkout HEAD^
|
|
|
|
|
@ -244,12 +244,12 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
|
|
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
|
- name: Checkout
|
|
|
|
|
uses: actions/checkout@v5
|
|
|
|
|
uses: actions/checkout@v6
|
|
|
|
|
with:
|
|
|
|
|
path: main
|
|
|
|
|
|
|
|
|
|
- name: Checkout tools repo
|
|
|
|
|
uses: actions/checkout@v5
|
|
|
|
|
uses: actions/checkout@v6
|
|
|
|
|
with:
|
|
|
|
|
repository: my-org/my-tools
|
|
|
|
|
path: my-tools
|
|
|
|
|
@ -260,10 +260,10 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
|
|
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
|
- name: Checkout
|
|
|
|
|
uses: actions/checkout@v5
|
|
|
|
|
uses: actions/checkout@v6
|
|
|
|
|
|
|
|
|
|
- name: Checkout tools repo
|
|
|
|
|
uses: actions/checkout@v5
|
|
|
|
|
uses: actions/checkout@v6
|
|
|
|
|
with:
|
|
|
|
|
repository: my-org/my-tools
|
|
|
|
|
path: my-tools
|
|
|
|
|
@ -274,12 +274,12 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
|
|
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
|
- name: Checkout
|
|
|
|
|
uses: actions/checkout@v5
|
|
|
|
|
uses: actions/checkout@v6
|
|
|
|
|
with:
|
|
|
|
|
path: main
|
|
|
|
|
|
|
|
|
|
- name: Checkout private tools
|
|
|
|
|
uses: actions/checkout@v5
|
|
|
|
|
uses: actions/checkout@v6
|
|
|
|
|
with:
|
|
|
|
|
repository: my-org/my-private-tools
|
|
|
|
|
token: ${{ secrets.GH_PAT }} # `GH_PAT` is a secret that contains your PAT
|
|
|
|
|
@ -292,7 +292,7 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
|
|
|
|
|
## Checkout pull request HEAD commit instead of merge commit
|
|
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
|
- uses: actions/checkout@v5
|
|
|
|
|
- uses: actions/checkout@v6
|
|
|
|
|
with:
|
|
|
|
|
ref: ${{ github.event.pull_request.head.sha }}
|
|
|
|
|
```
|
|
|
|
|
@ -308,7 +308,7 @@ jobs:
|
|
|
|
|
build:
|
|
|
|
|
runs-on: ubuntu-latest
|
|
|
|
|
steps:
|
|
|
|
|
- uses: actions/checkout@v5
|
|
|
|
|
- uses: actions/checkout@v6
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Push a commit using the built-in token
|
|
|
|
|
@ -319,7 +319,7 @@ jobs:
|
|
|
|
|
build:
|
|
|
|
|
runs-on: ubuntu-latest
|
|
|
|
|
steps:
|
|
|
|
|
- uses: actions/checkout@v5
|
|
|
|
|
- uses: actions/checkout@v6
|
|
|
|
|
- run: |
|
|
|
|
|
date > generated.txt
|
|
|
|
|
# Note: the following account information will not work on GHES
|
|
|
|
|
@ -341,7 +341,7 @@ jobs:
|
|
|
|
|
build:
|
|
|
|
|
runs-on: ubuntu-latest
|
|
|
|
|
steps:
|
|
|
|
|
- uses: actions/checkout@v5
|
|
|
|
|
- uses: actions/checkout@v6
|
|
|
|
|
with:
|
|
|
|
|
ref: ${{ github.head_ref }}
|
|
|
|
|
- run: |
|
|
|
|
|
|