* Add new public key for known_hosts (#1237)
* Add new public key for known_hosts
* Fix the build!
* fix build.
---------
Co-authored-by: Cameron Booth <cdb@github.com>
* Update licensed version
* Backport for submodule command wrapping
* Update NPM packages
* Update dist/index.js
* Rebuild using Node 12
* Rebuild after a more aggressive cleanup of local files
* Backport change to replace datadog/squid with ubuntu/squid
- [Fixed an issue where checkout failed to run in container jobs due to the new git setting `safe.directory`](https://github.com/actions/checkout/pull/762)
- [Bumped various npm package versions](https://github.com/actions/checkout/pull/744)
## v3.0.0
- [Update to node 16](https://github.com/actions/checkout/pull/689)
## v2.3.1
## v2.3.1
- [Fix default branch resolution for .wiki and when using SSH](https://github.com/actions/checkout/pull/284)
- [Fix default branch resolution for .wiki and when using SSH](https://github.com/actions/checkout/pull/284)
## v2.3.0
## v2.3.0
- [Fallback to the default branch](https://github.com/actions/checkout/pull/278)
- [Fallback to the default branch](https://github.com/actions/checkout/pull/278)
1. Configure and install the dependencies: `npm install`
1. Create a new branch: `git checkout -b my-branch-name`
1. Make your change, add tests, and make sure the tests still pass: `npm run test`
1. Make sure your code is correctly formatted: `npm run format`
1. Update `dist/index.js` using `npm run build`. This creates a single javascript file that is used as an entrypoint for the action
1. Push to your fork and submit a pull request
1. Pat yourself on the back and wait for your pull request to be reviewed and merged
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
- Write tests.
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
## Resources
- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
[](https://github.com/actions/checkout/actions/workflows/test.yml)
This action checks-out your repository under `$GITHUB_WORKSPACE`, so your workflow can access it.
This action checks-out your repository under `$GITHUB_WORKSPACE`, so your workflow can access it.
@ -12,14 +14,27 @@ When Git 2.18 or higher is not in your PATH, falls back to the REST API to downl
# What's new
# What's new
- Updated to the node16 runtime by default
- Improved performance
- 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.
- 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.
# Usage
# Usage
<!-- start usage -->
<!-- start usage -->
```yaml
```yaml
- uses: actions/checkout@v3
- uses: actions/checkout@v2
with:
with:
# Repository name with owner. For example, actions/checkout
# Repository name with owner. For example, actions/checkout
# Default: ${{ github.repository }}
# Default: ${{ github.repository }}
@ -95,12 +110,6 @@ When Git 2.18 or higher is not in your PATH, falls back to the REST API to downl
# config --global --add safe.directory <path>`
# config --global --add safe.directory <path>`
# Default: true
# Default: true
set-safe-directory: ''
set-safe-directory: ''
# The base URL for the GitHub instance that you are trying to clone from, will use
# environment defaults to fetch from the same instance that the workflow is
# running from unless specified. Example URLs are https://github.com or
# https://my-ghes-server.example.com
github-server-url: ''
```
```
<!-- end usage -->
<!-- end usage -->
@ -119,7 +128,7 @@ When Git 2.18 or higher is not in your PATH, falls back to the REST API to downl
## Fetch all history for all tags and branches
## Fetch all history for all tags and branches
```yaml
```yaml
- uses: actions/checkout@v3
- uses: actions/checkout@v2
with:
with:
fetch-depth: 0
fetch-depth: 0
```
```
@ -127,7 +136,7 @@ When Git 2.18 or higher is not in your PATH, falls back to the REST API to downl
## Checkout a different branch
## Checkout a different branch
```yaml
```yaml
- uses: actions/checkout@v3
- uses: actions/checkout@v2
with:
with:
ref: my-branch
ref: my-branch
```
```
@ -135,7 +144,7 @@ When Git 2.18 or higher is not in your PATH, falls back to the REST API to downl
## Checkout HEAD^
## Checkout HEAD^
```yaml
```yaml
- uses: actions/checkout@v3
- uses: actions/checkout@v2
with:
with:
fetch-depth: 2
fetch-depth: 2
- run: git checkout HEAD^
- run: git checkout HEAD^
@ -145,42 +154,40 @@ When Git 2.18 or higher is not in your PATH, falls back to the REST API to downl
```yaml
```yaml
- name: Checkout
- name: Checkout
uses: actions/checkout@v3
uses: actions/checkout@v2
with:
with:
path: main
path: main
- name: Checkout tools repo
- name: Checkout tools repo
uses: actions/checkout@v3
uses: actions/checkout@v2
with:
with:
repository: my-org/my-tools
repository: my-org/my-tools
path: my-tools
path: my-tools
```
```
> - If your secondary repository is private you will need to add the option noted in [Checkout multiple repos (private)](#Checkout-multiple-repos-private)
## Checkout multiple repos (nested)
## Checkout multiple repos (nested)
```yaml
```yaml
- name: Checkout
- name: Checkout
uses: actions/checkout@v3
uses: actions/checkout@v2
- name: Checkout tools repo
- name: Checkout tools repo
uses: actions/checkout@v3
uses: actions/checkout@v2
with:
with:
repository: my-org/my-tools
repository: my-org/my-tools
path: my-tools
path: my-tools
```
```
> - If your secondary repository is private you will need to add the option noted in [Checkout multiple repos (private)](#Checkout-multiple-repos-private)
## Checkout multiple repos (private)
## Checkout multiple repos (private)
```yaml
```yaml
- name: Checkout
- name: Checkout
uses: actions/checkout@v3
uses: actions/checkout@v2
with:
with:
path: main
path: main
- name: Checkout private tools
- name: Checkout private tools
uses: actions/checkout@v3
uses: actions/checkout@v2
with:
with:
repository: my-org/my-private-tools
repository: my-org/my-private-tools
token: ${{ secrets.GH_PAT }} # `GH_PAT` is a secret that contains your PAT
token: ${{ secrets.GH_PAT }} # `GH_PAT` is a secret that contains your PAT
@ -193,7 +200,7 @@ When Git 2.18 or higher is not in your PATH, falls back to the REST API to downl
## Checkout pull request HEAD commit instead of merge commit
## Checkout pull request HEAD commit instead of merge commit
description:Add repository path as safe.directory for Git global config by running `git config --global --add safe.directory <path>`
description:Add repository path as safe.directory for Git global config by running `git config --global --add safe.directory <path>`
default:true
default:true
github-server-url:
description:The base URL for the GitHub instance that you are trying to clone from, will use environment defaults to fetch from the same instance that the workflow is running from unless specified. Example URLs are https://github.com or https://my-ghes-server.example.com
Tingluo Huang
Cory Miller
Francesco Renzi
Thomas Boop