From 72f2cec99f417b1a1c5e2e88945068983b7965f9 Mon Sep 17 00:00:00 2001 From: Varun Sivapalan <5470233+sivapalan@users.noreply.github.com> Date: Tue, 5 Sep 2023 15:21:52 +0200 Subject: [PATCH] Update README.md for V4 (#1452) * Update README.md for V4 * Update actionReference in generate-docs.ts for v4 --- README.md | 39 ++++++++++++++++++++------------------- src/misc/generate-docs.ts | 2 +- 2 files changed, 21 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 982748a..7e76cde 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ [![Build and Test](https://github.com/actions/checkout/actions/workflows/test.yml/badge.svg)](https://github.com/actions/checkout/actions/workflows/test.yml) -# Checkout V3 +# Checkout V4 This action checks-out your repository under `$GITHUB_WORKSPACE`, so your workflow can access it. @@ -12,14 +12,15 @@ When Git 2.18 or higher is not in your PATH, falls back to the REST API to downl # What's new -- Updated to the node16 runtime by default - - This requires a minimum [Actions Runner](https://github.com/actions/runner/releases/tag/v2.285.0) version of v2.285.0 to run, which is by default available in GHES 3.4 or later. +- Updated default runtime to node20 + - This requires a minimum Actions Runner version of [v2.308.0](https://github.com/actions/runner/releases/tag/v2.308.0). +- Added support for fetching without the `--progress` option # Usage ```yaml -- uses: actions/checkout@v3 +- uses: actions/checkout@v4 with: # Repository name with owner. For example, actions/checkout # Default: ${{ github.repository }} @@ -139,7 +140,7 @@ When Git 2.18 or higher is not in your PATH, falls back to the REST API to downl ## Fetch only the root files ```yaml -- uses: actions/checkout@v3 +- uses: actions/checkout@v4 with: sparse-checkout: . ``` @@ -147,7 +148,7 @@ When Git 2.18 or higher is not in your PATH, falls back to the REST API to downl ## Fetch only the root files and `.github` and `src` folder ```yaml -- uses: actions/checkout@v3 +- uses: actions/checkout@v4 with: sparse-checkout: | .github @@ -157,7 +158,7 @@ When Git 2.18 or higher is not in your PATH, falls back to the REST API to downl ## Fetch only a single file ```yaml -- uses: actions/checkout@v3 +- uses: actions/checkout@v4 with: sparse-checkout: | README.md @@ -167,7 +168,7 @@ When Git 2.18 or higher is not in your PATH, falls back to the REST API to downl ## Fetch all history for all tags and branches ```yaml -- uses: actions/checkout@v3 +- uses: actions/checkout@v4 with: fetch-depth: 0 ``` @@ -175,7 +176,7 @@ When Git 2.18 or higher is not in your PATH, falls back to the REST API to downl ## Checkout a different branch ```yaml -- uses: actions/checkout@v3 +- uses: actions/checkout@v4 with: ref: my-branch ``` @@ -183,7 +184,7 @@ When Git 2.18 or higher is not in your PATH, falls back to the REST API to downl ## Checkout HEAD^ ```yaml -- uses: actions/checkout@v3 +- uses: actions/checkout@v4 with: fetch-depth: 2 - run: git checkout HEAD^ @@ -193,12 +194,12 @@ When Git 2.18 or higher is not in your PATH, falls back to the REST API to downl ```yaml - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: path: main - name: Checkout tools repo - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: repository: my-org/my-tools path: my-tools @@ -209,10 +210,10 @@ When Git 2.18 or higher is not in your PATH, falls back to the REST API to downl ```yaml - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Checkout tools repo - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: repository: my-org/my-tools path: my-tools @@ -223,12 +224,12 @@ When Git 2.18 or higher is not in your PATH, falls back to the REST API to downl ```yaml - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: path: main - name: Checkout private tools - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: repository: my-org/my-private-tools token: ${{ secrets.GH_PAT }} # `GH_PAT` is a secret that contains your PAT @@ -241,7 +242,7 @@ When Git 2.18 or higher is not in your PATH, falls back to the REST API to downl ## Checkout pull request HEAD commit instead of merge commit ```yaml -- uses: actions/checkout@v3 +- uses: actions/checkout@v4 with: ref: ${{ github.event.pull_request.head.sha }} ``` @@ -257,7 +258,7 @@ jobs: build: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 ``` ## Push a commit using the built-in token @@ -268,7 +269,7 @@ jobs: build: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - run: | date > generated.txt git config user.name github-actions diff --git a/src/misc/generate-docs.ts b/src/misc/generate-docs.ts index 57d2888..5e67969 100644 --- a/src/misc/generate-docs.ts +++ b/src/misc/generate-docs.ts @@ -120,7 +120,7 @@ function updateUsage( } updateUsage( - 'actions/checkout@v3', + 'actions/checkout@v4', path.join(__dirname, '..', '..', 'action.yml'), path.join(__dirname, '..', '..', 'README.md') )