diff options
| -rw-r--r-- | CHANGELOG.md | 20 | ||||
| -rw-r--r-- | README.md | 20 | ||||
| -rw-r--r-- | src/misc/generate-docs.ts | 2 |
3 files changed, 29 insertions, 13 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md index d5063ae..7546e84 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,20 +1,20 @@ # Changelog -## v2 (preview) +## v2 (beta) - Improved fetch performance - - The default behavior now fetches only the SHA being checked-out. + - The default behavior now fetches only the SHA being checked-out - Script authenticated git commands - - Persists `with.token` in the local git config. - - Enables your scripts to run authenticated git commands. - - Post-job cleanup removes the token. - - Coming soon: Opt out by setting `with.persist-credentials` to `false`. + - Persists `with.token` in the local git config + - Enables your scripts to run authenticated git commands + - Post-job cleanup removes the token + - Coming soon: Opt out by setting `with.persist-credentials` to `false` - Creates a local branch - - No longer detached HEAD when checking out a branch. - - A local branch is created with the corresponding upstream branch set. + - No longer detached HEAD when checking out a branch + - A local branch is created with the corresponding upstream branch set - Improved layout - - `with.path` is always relative to `github.workspace`. - - Aligns better with container actions, where `github.workspace` gets mapped in. + - `with.path` is always relative to `github.workspace` + - Aligns better with container actions, where `github.workspace` gets mapped in - Removed input `submodules` @@ -2,7 +2,7 @@ <a href="https://github.com/actions/checkout"><img alt="GitHub Actions status" src="https://github.com/actions/checkout/workflows/test-local/badge.svg"></a> </p> -# Checkout V2 (preview) +# Checkout V2 (beta) This action checks-out your repository under `$GITHUB_WORKSPACE`, so your workflow can access it. @@ -10,13 +10,29 @@ By default, the repository that triggered the workflow is checked-out, for the r Refer [here](https://help.github.com/en/articles/events-that-trigger-workflows) to learn which commit `$GITHUB_SHA` points to for different events. +Changes in V2: +- Improved fetch performance + - The default behavior now fetches only the SHA being checked-out +- Script authenticated git commands + - Persists `with.token` in the local git config + - Enables your scripts to run authenticated git commands + - Post-job cleanup removes the token + - Coming soon: Opt out by setting `with.persist-credentials` to `false` +- Creates a local branch + - No longer detached HEAD when checking out a branch + - A local branch is created with the corresponding upstream branch set +- Improved layout + - `with.path` is always relative to `github.workspace` + - Aligns better with container actions, where `github.workspace` gets mapped in +- Removed input `submodules` + Refer [here](https://github.com/actions/checkout/blob/v1/README.md) for previous versions. # Usage <!-- start usage --> ```yaml -- uses: actions/checkout@preview +- uses: actions/checkout@v2-beta with: # Repository name # Default: ${{ github.repository }} diff --git a/src/misc/generate-docs.ts b/src/misc/generate-docs.ts index c882c55..28bab38 100644 --- a/src/misc/generate-docs.ts +++ b/src/misc/generate-docs.ts @@ -96,7 +96,7 @@ function updateUsage( } updateUsage( - 'actions/checkout@preview', + 'actions/checkout@v2-beta', path.join(__dirname, '..', '..', 'action.yml'), path.join(__dirname, '..', '..', 'README.md') ) |