From cbe1c262c7f816506d9caa79c055661a20627ec4 Mon Sep 17 00:00:00 2001 From: Thomas Boop Date: Tue, 1 Mar 2022 12:17:33 -0500 Subject: [PATCH 1/3] update readme for v3 --- README.md | 26 +++++++++++++------------- src/misc/generate-docs.ts | 2 +- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 775cee592..6f3932305 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ Refer [here](https://github.com/actions/checkout/blob/v1/README.md) for previous ```yaml -- uses: actions/checkout@v2 +- uses: actions/checkout@v3 with: # Repository name with owner. For example, actions/checkout # Default: ${{ github.repository }} @@ -123,7 +123,7 @@ Refer [here](https://github.com/actions/checkout/blob/v1/README.md) for previous ## Fetch all history for all tags and branches ```yaml -- uses: actions/checkout@v2 +- uses: actions/checkout@v3 with: fetch-depth: 0 ``` @@ -131,7 +131,7 @@ Refer [here](https://github.com/actions/checkout/blob/v1/README.md) for previous ## Checkout a different branch ```yaml -- uses: actions/checkout@v2 +- uses: actions/checkout@v3 with: ref: my-branch ``` @@ -139,7 +139,7 @@ Refer [here](https://github.com/actions/checkout/blob/v1/README.md) for previous ## Checkout HEAD^ ```yaml -- uses: actions/checkout@v2 +- uses: actions/checkout@v3 with: fetch-depth: 2 - run: git checkout HEAD^ @@ -149,12 +149,12 @@ Refer [here](https://github.com/actions/checkout/blob/v1/README.md) for previous ```yaml - name: Checkout - uses: actions/checkout@v2 + uses: actions/checkout@v3 with: path: main - name: Checkout tools repo - uses: actions/checkout@v2 + uses: actions/checkout@v3 with: repository: my-org/my-tools path: my-tools @@ -164,10 +164,10 @@ Refer [here](https://github.com/actions/checkout/blob/v1/README.md) for previous ```yaml - name: Checkout - uses: actions/checkout@v2 + uses: actions/checkout@v3 - name: Checkout tools repo - uses: actions/checkout@v2 + uses: actions/checkout@v3 with: repository: my-org/my-tools path: my-tools @@ -177,12 +177,12 @@ Refer [here](https://github.com/actions/checkout/blob/v1/README.md) for previous ```yaml - name: Checkout - uses: actions/checkout@v2 + uses: actions/checkout@v3 with: path: main - name: Checkout private tools - uses: actions/checkout@v2 + uses: actions/checkout@v3 with: repository: my-org/my-private-tools token: ${{ secrets.GH_PAT }} # `GH_PAT` is a secret that contains your PAT @@ -195,7 +195,7 @@ Refer [here](https://github.com/actions/checkout/blob/v1/README.md) for previous ## Checkout pull request HEAD commit instead of merge commit ```yaml -- uses: actions/checkout@v2 +- uses: actions/checkout@v3 with: ref: ${{ github.event.pull_request.head.sha }} ``` @@ -211,7 +211,7 @@ jobs: build: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 ``` ## Push a commit using the built-in token @@ -222,7 +222,7 @@ jobs: build: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - 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 a1c845dc5..57d28889b 100644 --- a/src/misc/generate-docs.ts +++ b/src/misc/generate-docs.ts @@ -120,7 +120,7 @@ function updateUsage( } updateUsage( - 'actions/checkout@v2', + 'actions/checkout@v3', path.join(__dirname, '..', '..', 'action.yml'), path.join(__dirname, '..', '..', 'README.md') ) From bcd0a37b4993adc08737509ee0861efa82b8e704 Mon Sep 17 00:00:00 2001 From: Thomas Boop Date: Tue, 1 Mar 2022 12:27:08 -0500 Subject: [PATCH 2/3] update readme with changes --- README.md | 19 +++---------------- 1 file changed, 3 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 6f3932305..a809e5fdf 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ GitHub Actions status

-# Checkout V2 +# Checkout V3 This action checks-out your repository under `$GITHUB_WORKSPACE`, so your workflow can access it. @@ -14,21 +14,8 @@ When Git 2.18 or higher is not in your PATH, falls back to the REST API to downl # What's new -- Improved performance - - Fetches only a single commit by default -- Script authenticated git commands - - Auth token persisted in the local git config -- Supports SSH -- Creates a local branch - - No longer detached HEAD when checking out a branch -- Improved layout - - The input `path` is always relative to $GITHUB_WORKSPACE - - Aligns better with container actions, where $GITHUB_WORKSPACE gets mapped in -- Fallback to REST API download - - When Git 2.18 or higher is not in the PATH, the REST API will be used to download the files - - When using a job container, the container's PATH is used - -Refer [here](https://github.com/actions/checkout/blob/v1/README.md) for previous versions. +- Updated to the node16 runtime by default as node12 + - 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. # Usage From 39c34a7972f99e7dd38c06d82965c6e0b89ffa66 Mon Sep 17 00:00:00 2001 From: Thomas Boop Date: Tue, 1 Mar 2022 12:29:23 -0500 Subject: [PATCH 3/3] nit grammar --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a809e5fdf..b185d46b8 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ 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 as node12 +- 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. # Usage