Page d'accueil>Lié à la programmation>Autre code source
Télécharger

Checkout v4

Cette action vérifie votre référentiel sous $GITHUB_WORKSPACE , afin que votre flux de travail puisse y accéder.

Un seul engagement est récupéré par défaut, pour le ref / sha qui a déclenché le workflow. Définissez fetch-depth: 0 pour récupérer toute l'historique pour toutes les branches et tags. Reportez-vous ici pour savoir quel engagement $GITHUB_SHA pointe pour différents événements.

Le jeton Auth est persisté dans la configuration GIT locale. Cela permet à vos scripts d'exécuter des commandes GIT authentifiées. Le jeton est supprimé pendant le nettoyage post-emploi. Définissez persist-credentials: false to Opt-Out.

Lorsque GIT 2.18 ou plus n'est pas sur votre chemin, retombe à l'API de repos pour télécharger les fichiers.

Quoi de neuf

Veuillez vous référer à la page de version des dernières notes de version.

Usage 

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

Scénarios

  • Reprendre uniquement les fichiers racine
  • Reprochez uniquement les fichiers racine et le dossier .github et src
  • Reprocher uniquement un seul fichier
  • Répondez toute l'historique pour toutes les balises et branches
  • Découvrez une succursale différente
  • Checkout Head ^
  • Vérifiez plusieurs reposs (côte à côte)
  • Vérifiez plusieurs reposs (imbriqué)
  • Vérifiez plusieurs reposs (privé)
  • Découvrez la demande d'attraction de la demande.
  • Demande d'attraction de paiement sur l'événement fermé
  • Pousser un engagement en utilisant le jeton intégré
  • Poussez un engagement à un RP en utilisant le jeton intégré

Reprendre uniquement les fichiers racine 

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

Reprochez uniquement les fichiers racine et le dossier .github et src 

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

Reprocher uniquement un seul fichier 

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

Répondez toute l'historique pour toutes les balises et branches 

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

Découvrez une succursale différente 

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

Checkout Head ^ 

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

Vérifiez plusieurs reposs (côte à côte) 

- 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 votre référentiel secondaire est privé ou interne, vous devrez ajouter l'option notée dans la caisse de plusieurs reposs (privé)

Vérifiez plusieurs reposs (imbriqué) 

- name : Checkout
  uses : actions/checkout@v4

- name : Checkout tools repo
  uses : actions/checkout@v4
  with :
    repository : my-org/my-tools
    path : my-tools
  • Si votre référentiel secondaire est privé ou interne, vous devrez ajouter l'option notée dans la caisse de plusieurs reposs (privé)

Vérifiez plusieurs reposs (privé) 

- 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 portée dans le référentiel actuel, donc si vous souhaitez vérifier un référentiel différent qui est privé, vous devrez fournir votre propre PAT.

Découvrez la demande d'attraction de la demande. 

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

Demande d'attraction de paiement sur l'événement fermé 

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

Pousser un engagement en utilisant le jeton intégré 

 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

Remarque: l'e-mail de l'utilisateur est {user.id}+{user.login}@users.noreply.github.com . Voir l'API des utilisateurs: https://api.github.com/users/github-actions%5bbot%5d

Poussez un engagement à un RP en utilisant le jeton intégré

Dans un déclencheur de demande de traction, ref est requis car les actions GitHub vérifient en mode tête détachée, ce qui signifie qu'il ne consulte pas votre branche par défaut. 

 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

Remarque: l'e-mail de l'utilisateur est {user.id}+{user.login}@users.noreply.github.com . Voir l'API des utilisateurs: https://api.github.com/users/github-actions%5bbot%5d

Licence

Les scripts et la documentation de ce projet sont publiés sous la licence MIT

Développer
Informations supplémentaires
Applications connexes
Recommandé pour vous
Actualités connexes Tout