Compare commits

...

1 Commits

Author SHA1 Message Date
Thomas Boop d8d55467a3 Revert "Upgrade checkout to v1.1.0 to better support scripting git. (#56)"
This reverts commit 0b496e91ec.
5 years ago

@ -1,18 +0,0 @@
name: "test-local"
on:
pull_request:
push:
branches:
- master
- 'releases/*'
jobs:
test:
strategy:
matrix:
os: [windows-latest, ubuntu-latest, macOS-latest]
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@master
- uses: ./
- run: git ls-remote --tags origin

@ -1,8 +1,4 @@
<p align="center"> # checkout
<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
This action checks out your repository to `$GITHUB_WORKSPACE`, so that your workflow can access the contents of your repository. This action checks out your repository to `$GITHUB_WORKSPACE`, so that your workflow can access the contents of your repository.
@ -17,48 +13,23 @@ Basic:
```yaml ```yaml
steps: steps:
- uses: actions/checkout@v1 - uses: actions/checkout@master
- uses: actions/setup-node@v1 - uses: actions/setup-node@master
with: with:
node-version: 10.x node-version: 10.x
- run: npm install - run: npm install
- run: npm test - run: npm test
``` ```
By default, the branch or tag ref that triggered the workflow will be checked out, `${{ github.token }}` will be used for any Git server authentication. If you wish to check out a different branch, a different repository or use different token to checkout, specify that using `with.ref`, `with.repository` and `with.token`: By default, the branch or tag ref that triggered the workflow will be checked out. If you wish to check out a different branch, specify that using `with.ref`:
Checkout different branch from the workflow repository:
```yaml ```yaml
- uses: actions/checkout@v1 - uses: actions/checkout@master
with: with:
ref: some-branch ref: some-branch
``` ```
Checkout different private repository: For more details, see [Contexts and expression syntax for GitHub Actions](https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions)
```yaml
- uses: actions/checkout@v1
with:
repository: myAccount/myRepository
ref: refs/heads/release
token: ${{ secrets.GitHub_PAT }} // `GitHub_PAT` is a secret contains your PAT.
```
Checkout private submodules:
```yaml
- uses: actions/checkout@v1
with:
submodules: recursive
token: ${{ secrets.GitHub_PAT }} // `GitHub_PAT` is a secret contains your PAT.
```
> - `with.token` will be used as `Basic` authentication header for https requests talk to https://github.com from `git(.exe)`, ensure those private submodules are configured via `https` not `ssh`.
> - `${{ github.token }}` only has permission to the workflow triggering repository. If the repository contains any submodules that comes from private repository, you will have to add your PAT as secret and use the secret in `with.token` to make `checkout` action work.
For more details, see [Contexts and expression syntax for GitHub Actions](https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions) and [Creating and using secrets (encrypted variables)](https://help.github.com/en/articles/virtual-environments-for-github-actions#creating-and-using-secrets-encrypted-variables)
# Changelog
## v1.1.0 (unreleased)
- Persist `with.token` or `${{ github.token }}` into checkout repository's git config as `http.https://github.com/.extraheader=AUTHORIZATION: basic ***` to better support scripting git
# License # License

@ -20,4 +20,4 @@ inputs:
description: 'Optional path to check out source code' description: 'Optional path to check out source code'
runs: runs:
# Plugins live on the runner and are only available to a certain set of first party actions. # Plugins live on the runner and are only available to a certain set of first party actions.
plugin: 'checkoutV1_1' plugin: 'checkout'

Loading…
Cancel
Save