When trying to list local branches to figure out what needs cleaned up during runs on non-ephemeral Actions Runners, we use git rev-parse --symbolic-full-name to get a list of branches. This can lead to ambiguous ref name errors when there are branches and tags with similar names.
Part of the reason we use rev-parse --symbolic-full-name vs git branch --list or git rev-parse --symbolic seems to related to a bug in Git 2.18. Until we can deprecate our usage of Git 2.18, I think we need to keep --symbolic-full-name. Since part of the problem is that these ambiguous ref name errors clog the Actions annotation limits, this is a mitigation to suppress those messages until we can get rid of the workaround.
* wrap pipeline commands for submoduleForeach in quotes
* Update src/git-auth-helper.ts
drop extraneous space.
Co-authored-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
* Followed CONTRIBUTING.md instructions, updating dist/index.js
* fixed package-lock.json
* updating the pipeline so it runs from sh
Co-authored-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
* Adding the ability to specify the GitHub Server URL and allowing for it to differ from the Actions workflow host
* Adding tests for injecting the GitHub URL
* Addressing code review comments for PR #922
- [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.
@ -14,27 +12,14 @@ 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
- Improved performance
- Updated to the node16 runtime by default
- Fetches only a single commit 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.
- 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@v2
- uses: actions/checkout@v3
with:
with:
# Repository name with owner. For example, actions/checkout
# Repository name with owner. For example, actions/checkout
# Default: ${{ github.repository }}
# Default: ${{ github.repository }}
@ -110,6 +95,12 @@ Refer [here](https://github.com/actions/checkout/blob/v1/README.md) for previous
# 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 -->
@ -128,7 +119,7 @@ Refer [here](https://github.com/actions/checkout/blob/v1/README.md) for previous
## Fetch all history for all tags and branches
## Fetch all history for all tags and branches
```yaml
```yaml
- uses: actions/checkout@v2
- uses: actions/checkout@v3
with:
with:
fetch-depth: 0
fetch-depth: 0
```
```
@ -136,7 +127,7 @@ Refer [here](https://github.com/actions/checkout/blob/v1/README.md) for previous
## Checkout a different branch
## Checkout a different branch
```yaml
```yaml
- uses: actions/checkout@v2
- uses: actions/checkout@v3
with:
with:
ref: my-branch
ref: my-branch
```
```
@ -144,7 +135,7 @@ Refer [here](https://github.com/actions/checkout/blob/v1/README.md) for previous
## Checkout HEAD^
## Checkout HEAD^
```yaml
```yaml
- uses: actions/checkout@v2
- uses: actions/checkout@v3
with:
with:
fetch-depth: 2
fetch-depth: 2
- run: git checkout HEAD^
- run: git checkout HEAD^
@ -154,40 +145,42 @@ Refer [here](https://github.com/actions/checkout/blob/v1/README.md) for previous
```yaml
```yaml
- name: Checkout
- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v3
with:
with:
path: main
path: main
- name: Checkout tools repo
- name: Checkout tools repo
uses: actions/checkout@v2
uses: actions/checkout@v3
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@v2
uses: actions/checkout@v3
- name: Checkout tools repo
- name: Checkout tools repo
uses: actions/checkout@v2
uses: actions/checkout@v3
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@v2
uses: actions/checkout@v3
with:
with:
path: main
path: main
- name: Checkout private tools
- name: Checkout private tools
uses: actions/checkout@v2
uses: actions/checkout@v3
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
@ -200,7 +193,7 @@ Refer [here](https://github.com/actions/checkout/blob/v1/README.md) for previous
## 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
Cameron Booth
Tingluo Huang
Cory Miller
Bassem Dghaidi
Andrew Scheller
Ryan van Zeben
Vallie Joseph
Jok
Scott Brenner
Francesco Renzi
Peter Murray
Thomas Boop
dependabot[bot]
Edward Thomson