mirror of
https://github.com/actions/checkout.git
synced 2024-10-06 22:49:29 +03:00
Action for checking out a repo
__test__ | ||
.github/workflows | ||
dist | ||
src | ||
.eslintignore | ||
.eslintrc.json | ||
.gitignore | ||
.prettierignore | ||
.prettierrc.json | ||
action.yml | ||
CHANGELOG.md | ||
jest.config.js | ||
LICENSE | ||
package-lock.json | ||
package.json | ||
README.md | ||
tsconfig.json |
Checkout V2 beta
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.
Changes in V2:
- Improved fetch performance
- The default behavior now fetches only the SHA being checked-out
- Script authenticated git commands
- Persists
with.token
in the local git config - Enables your scripts to run authenticated git commands
- Post-job cleanup removes the token
- Coming soon: Opt out by setting
with.persist-credentials
tofalse
- Persists
- 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
with.path
is always relative togithub.workspace
- Aligns better with container actions, where
github.workspace
gets mapped in
- Removed input
submodules
Refer here for previous versions.
Usage
- uses: actions/checkout@v2-beta
with:
# Repository name with owner. For example, actions/checkout
# Default: ${{ github.repository }}
repository: ''
# Ref to checkout (SHA, branch, tag). For the repository that triggered the
# workflow, defaults to the ref/SHA for the event. Otherwise defaults to master.
ref: ''
# Access token for clone repository
# Default: ${{ github.token }}
token: ''
# 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@preview
with:
ref: some-branch
Checkout a different, private repository
- uses: actions/checkout@preview
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.
License
The scripts and documentation in this project are released under the MIT License