Go to file
eric sciple 722adc63f1
update examples to reference v2 tag (#110)
2019-12-13 00:00:48 -05:00
.github/workflows update examples to reference v2 tag (#110) 2019-12-13 00:00:48 -05:00
__test__ add input persist-credentials (#107) 2019-12-12 13:49:26 -05:00
dist do not pass cred on command line (#108) 2019-12-12 14:04:04 -05:00
src update examples to reference v2 tag (#110) 2019-12-13 00:00:48 -05:00
.eslintignore Convert checkout to a regular action (#70) 2019-12-03 10:28:59 -05:00
.eslintrc.json Convert checkout to a regular action (#70) 2019-12-03 10:28:59 -05:00
.gitignore Convert checkout to a regular action (#70) 2019-12-03 10:28:59 -05:00
.prettierignore Convert checkout to a regular action (#70) 2019-12-03 10:28:59 -05:00
.prettierrc.json Convert checkout to a regular action (#70) 2019-12-03 10:28:59 -05:00
CHANGELOG.md update readme (#82) 2019-12-03 11:26:12 -05:00
LICENSE Add docs (#2) 2019-07-23 15:32:03 -04:00
README.md update examples to reference v2 tag (#110) 2019-12-13 00:00:48 -05:00
action.yml add input persist-credentials (#107) 2019-12-12 13:49:26 -05:00
jest.config.js Convert checkout to a regular action (#70) 2019-12-03 10:28:59 -05:00
package-lock.json fallback to REST API to download repo (#104) 2019-12-12 13:16:16 -05:00
package.json fallback to REST API to download repo (#104) 2019-12-12 13:16:16 -05:00
tsconfig.json Convert checkout to a regular action (#70) 2019-12-03 10:28:59 -05:00

README.md

GitHub Actions status

Checkout V2

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

By default, the repository that triggered the workflow is checked-out, for the ref/SHA that triggered the event.

Refer here to learn which commit $GITHUB_SHA points to for different events.

What's new

  • Improved fetch performance
    • The default behavior now fetches only the commit being checked-out
  • Script authenticated git commands
    • Persists the input token in the local git config
    • Enables your scripts to run authenticated git commands
    • Post-job cleanup removes the token
    • Opt out by setting the input persist-credentials: false
  • Creates a local branch
    • No longer detached HEAD when checking out a branch
    • A local branch is created with the corresponding upstream branch set
  • 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
  • Removed input submodules

Refer here for previous versions.

Usage

- uses: actions/checkout@v2
  with:
    # Repository name with owner. For example, actions/checkout
    # Default: ${{ github.repository }}
    repository: ''

    # The branch, tag or SHA to checkout. When checking out the repository that
    # triggered a workflow, this defaults to the reference or SHA for that event.
    # Otherwise, defaults to `master`.
    ref: ''

    # Auth token used to fetch the repository. The token is stored in the local git
    # config, which enables your scripts to run authenticated git commands. The
    # post-job step removes the token from the git config.
    # Default: ${{ github.token }}
    token: ''

    # Whether to persist the token in the git config
    # Default: true
    persist-credentials: ''

    # Relative path under $GITHUB_WORKSPACE to place the repository
    path: ''

    # Whether to execute `git clean -ffdx && git reset --hard HEAD` before fetching
    # Default: true
    clean: ''

    # Number of commits to fetch. 0 indicates all history.
    # Default: 1
    fetch-depth: ''

    # Whether to download Git-LFS files
    # Default: false
    lfs: ''

Checkout a different branch

- uses: actions/checkout@v2
  with:
    ref: some-branch

Checkout a different, private repository

- uses: actions/checkout@v2
  with:
    repository: myAccount/myRepository
    ref: refs/heads/master
    token: ${{ secrets.GitHub_PAT }} # `GitHub_PAT` is a secret that contains your PAT
  • ${{ github.token }} is scoped to the current repository, so if you want to checkout another repository that is private you will need to provide your own PAT.

Checkout the HEAD commit of a PR, rather than the merge commit

- uses: actions/checkout@v2
  with:
    ref: ${{ github.event.pull_request.head.sha }}

License

The scripts and documentation in this project are released under the MIT License