首頁>編程相關>其他源碼
下載

結帳V4

此操作將您的存儲庫在$GITHUB_WORKSPACE下刪除，因此您的工作流可以訪問它。

對於觸發工作流的參考/sha，默認情況下僅獲取一個提交。設置fetch-depth: 0以獲取所有分支和標籤的所有歷史記錄。請參閱此處了解哪個$GITHUB_SHA指向不同事件的指向。

驗證令牌在本地git配置中持續存在。這使您的腳本可以運行已驗證的git命令。在工作後清理期間，將其刪除。設置persist-credentials: false到選擇退出。

當Git 2.18或更高版本不在您的路徑中時，落回到REST API下載文件。

什麼是新的

請參閱發布頁面以獲取最新發行說明。

用法

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

方案

  • 僅獲取根文件
  • 僅獲取root文件和.github和src文件夾
  • 僅獲取一個文件
  • 獲取所有標籤和分支的所有歷史記錄
  • 結帳一個不同的分支
  • 結帳頭^
  • 結帳多個存儲庫（並排）
  • 結帳多個存儲庫（嵌套）
  • 結帳多個存儲庫（私有）
  • 結帳拉請求頭提交而不是合併提交
  • 結帳時閉合事件請求
  • 使用內置令牌推動提交
  • 使用內置令牌將提交推向PR

僅獲取根文件

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

僅獲取root文件和.github和src文件夾

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

僅獲取一個文件

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

獲取所有標籤和分支的所有歷史記錄

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

結帳一個不同的分支

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

結帳頭^ 

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

結帳多個存儲庫（並排） 

- 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
  • 如果您的次要存儲庫是私有的或內部的，則需要在結帳多個存儲庫中添加選項（私有）

結帳多個存儲庫（嵌套） 

- name : Checkout
  uses : actions/checkout@v4

- name : Checkout tools repo
  uses : actions/checkout@v4
  with :
    repository : my-org/my-tools
    path : my-tools
  • 如果您的次要存儲庫是私有的或內部的，則需要在結帳多個存儲庫中添加選項（私有）

結帳多個存儲庫（私有） 

- 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 }}範圍範圍為當前存儲庫，因此，如果您想結帳另一個私有存儲庫，您將需要提供自己的pat。

結帳拉請求頭提交而不是合併提交

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

結帳時閉合事件請求

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

使用內置令牌推動提交

 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

注意：用戶電子郵件為{user.id}+{user.login}@users.noreply.github.com 。請參閱用戶API：https：//api.github.com/users/github-actions%5bbot%5D

使用內置令牌將提交推向PR

在拉動請求觸發器中，需要ref ，因為GITHUB操作在獨立的頭模式下檢查出去，這意味著它默認情況下不會檢查您的分支。 

 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

注意：用戶電子郵件為{user.id}+{user.login}@users.noreply.github.com 。請參閱用戶API：https：//api.github.com/users/github-actions%5bbot%5D

執照

該項目中的腳本和文檔是根據MIT許可證發布的

展開
附加信息
相關應用
爲您推薦
相關資訊 全部