action.yml

name: 'Checkout Action'
description: 'Checkout a Git repository.'
author: 'Namespace Labs'

inputs:
  repository:
    description: 'Repository name with owner. For example, namespacelabs/foundation'
    default: ${{ github.repository }}
  
  ref:
    description: >
      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.

  token:
    description: >
      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 }}

  fetch-depth:
    description: 'Number of commits to fetch. 0 indicates all history for all branches and tags.'
    default: "1"

  persist-credentials:
    description: 'Whether to configure the token or SSH key with the local git config'
    default: "true"
  
  path:
    description: 'Relative path under $GITHUB_WORKSPACE to place the repository'

  submodules:
    description: >
      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 `git@github.com:` are
      converted to HTTPS.
    default: "false"

  dissociate:
    description: >
      Whether to dissociate the checkout (and submodules, if any) from the Namespace Git mirror:
      `true` to dissociate the main checkout, `recursive` to dissociate the main checkout and
      all submodules.
    default: "false"

runs:
  using: node20
  main: dist/index.js