Difference between revisions of "GitHub Actions: uses: actions/checkout"
Jump to navigation
Jump to search
m (Welcome moved page GitHub Actions: actions/checkout@v3 to GitHub Actions: uses: actions/checkout@v3) |
|||
Line 3: | Line 3: | ||
* <code>[[actions]]/checkout@v3</code> | * <code>[[actions]]/checkout@v3</code> | ||
+ | |||
+ | <pre> | ||
+ | - uses: actions/checkout@v3 | ||
+ | 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, uses the default branch. | ||
+ | ref: '' | ||
+ | |||
+ | # Personal access token (PAT) used to fetch the repository. The PAT is configured | ||
+ | # with the local git config, which enables your scripts to run authenticated git | ||
+ | # commands. The post-job step removes the PAT. | ||
+ | # | ||
+ | # We recommend using a service account with the least permissions necessary. Also | ||
+ | # when generating a new PAT, select the least scopes necessary. | ||
+ | # | ||
+ | # [Learn more about creating and using encrypted secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets) | ||
+ | # | ||
+ | # Default: ${{ github.token }} | ||
+ | token: '' | ||
+ | |||
+ | # SSH key used to fetch the repository. The SSH key is configured with the local | ||
+ | # git config, which enables your scripts to run authenticated git commands. The | ||
+ | # post-job step removes the SSH key. | ||
+ | # | ||
+ | # We recommend using a service account with the least permissions necessary. | ||
+ | # | ||
+ | # [Learn more about creating and using encrypted secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets) | ||
+ | ssh-key: '' | ||
+ | |||
+ | # Known hosts in addition to the user and global host key database. The public SSH | ||
+ | # keys for a host may be obtained using the utility `ssh-keyscan`. For example, | ||
+ | # `ssh-keyscan github.com`. The public key for github.com is always implicitly | ||
+ | # added. | ||
+ | ssh-known-hosts: '' | ||
+ | |||
+ | # Whether to perform strict host key checking. When true, adds the options | ||
+ | # `StrictHostKeyChecking=yes` and `CheckHostIP=no` to the SSH command line. Use | ||
+ | # the input `ssh-known-hosts` to configure additional hosts. | ||
+ | # Default: true | ||
+ | ssh-strict: '' | ||
+ | |||
+ | # Whether to configure the token or SSH key with the local 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 for all branches and tags. | ||
+ | # Default: 1 | ||
+ | fetch-depth: '' | ||
+ | |||
+ | # Whether to download Git-LFS files | ||
+ | # Default: false | ||
+ | lfs: '' | ||
+ | |||
+ | # Whether to checkout submodules: `true` to checkout submodules or `recursive` to | ||
+ | # recursively checkout submodules. | ||
+ | # | ||
+ | # When the `ssh-key` input is not provided, SSH URLs beginning with | ||
+ | # `[email protected]:` are converted to HTTPS. | ||
+ | # | ||
+ | # Default: false | ||
+ | submodules: '' | ||
+ | |||
+ | # Add repository path as safe.directory for Git global config by running `git | ||
+ | # config --global --add safe.directory <path>` | ||
+ | # Default: true | ||
+ | set-safe-directory: '' | ||
+ | </pre> | ||
== Related == | == Related == |
Revision as of 12:10, 17 May 2022
actions/checkout@v3
- uses: actions/checkout@v3 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, uses the default branch. ref: '' # Personal access token (PAT) used to fetch the repository. The PAT is configured # with the local git config, which enables your scripts to run authenticated git # commands. The post-job step removes the PAT. # # We recommend using a service account with the least permissions necessary. Also # when generating a new PAT, select the least scopes necessary. # # [Learn more about creating and using encrypted secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets) # # Default: ${{ github.token }} token: '' # SSH key used to fetch the repository. The SSH key is configured with the local # git config, which enables your scripts to run authenticated git commands. The # post-job step removes the SSH key. # # We recommend using a service account with the least permissions necessary. # # [Learn more about creating and using encrypted secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets) ssh-key: '' # Known hosts in addition to the user and global host key database. The public SSH # keys for a host may be obtained using the utility `ssh-keyscan`. For example, # `ssh-keyscan github.com`. The public key for github.com is always implicitly # added. ssh-known-hosts: '' # Whether to perform strict host key checking. When true, adds the options # `StrictHostKeyChecking=yes` and `CheckHostIP=no` to the SSH command line. Use # the input `ssh-known-hosts` to configure additional hosts. # Default: true ssh-strict: '' # Whether to configure the token or SSH key with the local 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 for all branches and tags. # Default: 1 fetch-depth: '' # Whether to download Git-LFS files # Default: false lfs: '' # Whether to checkout submodules: `true` to checkout submodules or `recursive` to # recursively checkout submodules. # # When the `ssh-key` input is not provided, SSH URLs beginning with # `[email protected]:` are converted to HTTPS. # # Default: false submodules: '' # Add repository path as safe.directory for Git global config by running `git # config --global --add safe.directory <path>` # Default: true set-safe-directory: ''
Related
See also
- GitHub Actions,
act, .github/workflows/
,~/actions-runner/
,svc.sh
,deploy:, run:, runs-on:
,uses:
,steps:
,jobs:
,on:, env:, uses:, script:, continue-on-error:, template:, aws-actions, inputs:
,GITHUB_ENV, needs:, github.
, GitHub runner, my-docker-publish.yml, GitHub Actions variables, GitHub Actions contexts, GitHub Actions Importer, If:, SLSA, Actions Runner Controller (ARC),$GITHUB OUTPUT
,notify:
, Marketplace,GITHUB_TOKEN
Advertising: