action.yml 1.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041
  1. name: 'Checkout'
  2. description: 'Checkout a Git repository at a particular version'
  3. inputs:
  4. repository:
  5. description: 'Repository name with owner. For example, actions/checkout'
  6. default: ${{ github.repository }}
  7. ref:
  8. description: >
  9. The branch, tag or SHA to checkout. When checking out the repository that
  10. triggered a workflow, this defaults to the reference or SHA for that
  11. event. Otherwise, defaults to `master`.
  12. token:
  13. description: >
  14. Auth token used to fetch the repository. The token is stored in the local
  15. git config, which enables your scripts to run authenticated git commands.
  16. The post-job step removes the token from the git config. [Learn more about
  17. creating and using encrypted secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)
  18. default: ${{ github.token }}
  19. persist-credentials:
  20. description: 'Whether to persist the token in the git config'
  21. default: true
  22. path:
  23. description: 'Relative path under $GITHUB_WORKSPACE to place the repository'
  24. clean:
  25. description: 'Whether to execute `git clean -ffdx && git reset --hard HEAD` before fetching'
  26. default: true
  27. fetch-depth:
  28. description: 'Number of commits to fetch. 0 indicates all history.'
  29. default: 1
  30. lfs:
  31. description: 'Whether to download Git-LFS files'
  32. default: false
  33. submodules:
  34. description: >
  35. Whether to checkout submodules: `true` to checkout submodules or `recursive` to
  36. recursively checkout submodules.
  37. default: false
  38. runs:
  39. using: node12
  40. main: dist/index.js
  41. post: dist/index.js