checkout

Vista v4

Esta acción verifica su repositorio en $GITHUB_WORKSPACE , para que su flujo de trabajo pueda acceder a él.

Solo un solo confirmación se obtiene de forma predeterminada, para la ref/sha que activó el flujo de trabajo. Establezca fetch-depth: 0 para obtener toda la historia para todas las ramas y etiquetas. Consulte aquí para aprender a qué apunta $GITHUB_SHA para diferentes eventos.

El token de autenticación se persiste en la configuración Git local. Esto permite que sus scripts ejecuten comandos Git autenticados. El token se elimina durante la limpieza posterior al trabajo. Establezca persist-credentials: false para optar por no participar.

Cuando GIT 2.18 o superior no está en su camino, vuelve a la API REST para descargar los archivos.

Qué hay de nuevo

Consulte la página de lanzamiento para ver las últimas notas de versión.

Uso

- uses : actions/checkout@v4
  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 : ' '

    # The user to use when connecting to the remote SSH host. By default 'git' is
    # used.
    # Default: git
    ssh-user : ' '

    # 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 : ' '

    # Partially clone against a given filter. Overrides sparse-checkout if set.
    # Default: null
    filter : ' '

    # Do a sparse checkout on given patterns. Each pattern should be separated with
    # new lines.
    # Default: null
    sparse-checkout : ' '

    # Specifies whether to use cone-mode when doing a sparse checkout.
    # Default: true
    sparse-checkout-cone-mode : ' '

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

    # Whether to fetch tags, even if fetch-depth > 0.
    # Default: false
    fetch-tags : ' '

    # Whether to show progress status output when fetching.
    # Default: true
    show-progress : ' '

    # 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 : ' '

    # The base URL for the GitHub instance that you are trying to clone from, will use
    # environment defaults to fetch from the same instance that the workflow is
    # running from unless specified. Example URLs are https://github.com or
    # https://my-ghes-server.example.com
    github-server-url : ' '

Escenarios

• Obtener solo los archivos root
• Obtenga solo los archivos raíz y la carpeta .github y src
• Obtener solo un archivo
• Obtenga toda la historia para todas las etiquetas y ramas
• Vea una rama diferente
• Cabeza de pago^
• Consulte Múltiples repos (uno al lado del otro)
• Vuelva a ver Múltiples repos (anidados)
• Vea la comprobación múltiple repos (privado)
• Vuelva a controlar la solicitud de requisito de solicitud en lugar de fusionar commit
• Solicitud de extracción de pago en el evento cerrado
• Empuje una confirmación usando el token incorporado
• Empuje un compromiso con un PR utilizando el token incorporado

Obtener solo los archivos root

- uses : actions/checkout@v4
  with :
    sparse-checkout : . 

Obtenga solo los archivos raíz y la carpeta .github y src

- uses : actions/checkout@v4
  with :
    sparse-checkout : |
      .github
      src 

Obtener solo un archivo

- uses : actions/checkout@v4
  with :
    sparse-checkout : |
      README.md
    sparse-checkout-cone-mode : false 

Obtenga toda la historia para todas las etiquetas y ramas

- uses : actions/checkout@v4
  with :
    fetch-depth : 0 

Vea una rama diferente

- uses : actions/checkout@v4
  with :
    ref : my-branch 

Cabeza de pago^

- uses : actions/checkout@v4
  with :
    fetch-depth : 2
- run : git checkout HEAD^ 

Consulte Múltiples repos (uno al lado del otro)

- name : Checkout
  uses : actions/checkout@v4
  with :
    path : main

- name : Checkout tools repo
  uses : actions/checkout@v4
  with :
    repository : my-org/my-tools
    path : my-tools

• Si su repositorio secundario es privado o interno, deberá agregar la opción observada en el momento de pagar múltiples repos (privado)

Vuelva a ver Múltiples repos (anidados)

- name : Checkout
  uses : actions/checkout@v4

- name : Checkout tools repo
  uses : actions/checkout@v4
  with :
    repository : my-org/my-tools
    path : my-tools

• Si su repositorio secundario es privado o interno, deberá agregar la opción observada en el momento de pagar múltiples repos (privado)

Vea la comprobación múltiple repos (privado)

- name : Checkout
  uses : actions/checkout@v4
  with :
    path : main

- name : Checkout private tools
  uses : actions/checkout@v4
  with :
    repository : my-org/my-private-tools
    token : ${{ secrets.GH_PAT }} # `GH_PAT` is a secret that contains your PAT
    path : my-tools

• ${{ github.token }} está alcanzado al repositorio actual, por lo que si desea revisar un repositorio diferente que sea privado, deberá proporcionar su propia palmada.

Vuelva a controlar la solicitud de la solicitud de requisito en lugar de fusionar commit

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

Solicitud de extracción de pago en el evento cerrado

 on :
  pull_request :
    branches : [main]
    types : [opened, synchronize, closed]
jobs :
  build :
    runs-on : ubuntu-latest
    steps :
      - uses : actions/checkout@v4 

Empuje una confirmación usando el token incorporado

 on : push
jobs :
  build :
    runs-on : ubuntu-latest
    steps :
      - uses : actions/checkout@v4
      - run : |
          date > generated.txt
          # Note: the following account information will not work on GHES
          git config user.name "github-actions[bot]"
          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
          git add .
          git commit -m "generated"
          git push

NOTA: El correo electrónico del usuario es {user.id}+{user.login}@users.noreply.github.com . Consulte la API de los usuarios: https://api.github.com/users/github-actions%5bbot%5d

Empuje un compromiso con un PR utilizando el token incorporado

En un disparador de solicitud de extracción, se requiere ref ya que las acciones de GitHub se verifican en el modo de cabeza separada, lo que significa que no verifica su sucursal de forma predeterminada.

 on : pull_request
jobs :
  build :
    runs-on : ubuntu-latest
    steps :
      - uses : actions/checkout@v4
        with :
          ref : ${{ github.head_ref }}
      - run : |
          date > generated.txt
          # Note: the following account information will not work on GHES
          git config user.name "github-actions[bot]"
          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
          git add .
          git commit -m "generated"
          git push

NOTA: El correo electrónico del usuario es {user.id}+{user.login}@users.noreply.github.com . Consulte la API de los usuarios: https://api.github.com/users/github-actions%5bbot%5d

Licencia

Los scripts y la documentación en este proyecto se publican bajo la licencia del MIT