Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

update readme for v3 #708

Merged
merged 3 commits into from Mar 1, 2022
Merged

update readme for v3 #708

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cbe1c26
update readme for v3
thboop Mar 1, 2022
bcd0a37
update readme with changes
thboop Mar 1, 2022
39c34a7
nit grammar
thboop Mar 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
45 changes: 16 additions & 29 deletions README.md
View file
Open in desktop
Expand Up @@ -2,7 +2,7 @@
<a href="https://github.com/actions/checkout"><img alt="GitHub Actions status" src="https://github.com/actions/checkout/workflows/test-local/badge.svg"></a>
</p>

# Checkout V2
# Checkout V3

This action checks-out your repository under `$GITHUB_WORKSPACE`, so your workflow can access it.

Expand All @@ -14,27 +14,14 @@ When Git 2.18 or higher is not in your PATH, falls back to the REST API to downl

# What's new

- Improved performance
- Fetches only a single commit by default
- Script authenticated git commands
- Auth token persisted in the local git config
- Supports SSH
- Creates a local branch
- No longer detached HEAD when checking out a branch
- Improved layout
- The input `path` is always relative to $GITHUB_WORKSPACE
- Aligns better with container actions, where $GITHUB_WORKSPACE gets mapped in
- Fallback to REST API download
- When Git 2.18 or higher is not in the PATH, the REST API will be used to download the files
- When using a job container, the container's PATH is used

Refer [here](https://github.com/actions/checkout/blob/v1/README.md) for previous versions.
- Updated to the node16 runtime by default
- This requires a minimum [Actions Runner](https://github.com/actions/runner/releases/tag/v2.285.0) version of v2.285.0 to run, which is by default available in GHES 3.4 or later.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be worth explicitly mentioning here (and, more importantly, in https://github.com/actions/checkout/releases/tag/v3.0.0) that if you are using github.com (SaaS) you can safely accept the update and ignore the rest of the text.


# Usage

<!-- start usage -->
```yaml
- uses: actions/checkout@v2
- uses: actions/checkout@v3
with:
# Repository name with owner. For example, actions/checkout
# Default: ${{ github.repository }}
Expand Down Expand Up @@ -123,23 +110,23 @@ Refer [here](https://github.com/actions/checkout/blob/v1/README.md) for previous
## Fetch all history for all tags and branches

```yaml
- uses: actions/checkout@v2
- uses: actions/checkout@v3
with:
fetch-depth: 0
```

## Checkout a different branch

```yaml
- uses: actions/checkout@v2
- uses: actions/checkout@v3
with:
ref: my-branch
```

## Checkout HEAD^

```yaml
- uses: actions/checkout@v2
- uses: actions/checkout@v3
with:
fetch-depth: 2
- run: git checkout HEAD^
Expand All @@ -149,12 +136,12 @@ Refer [here](https://github.com/actions/checkout/blob/v1/README.md) for previous

```yaml
- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v3
with:
path: main

- name: Checkout tools repo
uses: actions/checkout@v2
uses: actions/checkout@v3
with:
repository: my-org/my-tools
path: my-tools
Expand All @@ -164,10 +151,10 @@ Refer [here](https://github.com/actions/checkout/blob/v1/README.md) for previous

```yaml
- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v3

- name: Checkout tools repo
uses: actions/checkout@v2
uses: actions/checkout@v3
with:
repository: my-org/my-tools
path: my-tools
Expand All @@ -177,12 +164,12 @@ Refer [here](https://github.com/actions/checkout/blob/v1/README.md) for previous

```yaml
- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v3
with:
path: main

- name: Checkout private tools
uses: actions/checkout@v2
uses: actions/checkout@v3
with:
repository: my-org/my-private-tools
token: ${{ secrets.GH_PAT }} # `GH_PAT` is a secret that contains your PAT
Expand All @@ -195,7 +182,7 @@ Refer [here](https://github.com/actions/checkout/blob/v1/README.md) for previous
## Checkout pull request HEAD commit instead of merge commit

```yaml
- uses: actions/checkout@v2
- uses: actions/checkout@v3
with:
ref: ${{ github.event.pull_request.head.sha }}
```
Expand All @@ -211,7 +198,7 @@ jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v3
```

## Push a commit using the built-in token
Expand All @@ -222,7 +209,7 @@ jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v3
- run: |
date > generated.txt
git config user.name github-actions
Expand Down
2 changes: 1 addition & 1 deletion src/misc/generate-docs.ts
View file
Open in desktop
Expand Up @@ -120,7 +120,7 @@ function updateUsage(
}

updateUsage(
'actions/checkout@v2',
'actions/checkout@v3',
path.join(__dirname, '..', '..', 'action.yml'),
path.join(__dirname, '..', '..', 'README.md')
)