mirror of
https://gitea.com/actions/checkout.git
synced 2024-11-09 16:21:48 +01:00
update readme (#82)
This commit is contained in:
parent
e347bba93b
commit
8461dbfed3
3 changed files with 29 additions and 13 deletions
20
CHANGELOG.md
20
CHANGELOG.md
|
@ -1,20 +1,20 @@
|
||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
## v2 (preview)
|
## v2 (beta)
|
||||||
|
|
||||||
- Improved fetch performance
|
- 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
|
- Script authenticated git commands
|
||||||
- Persists `with.token` in the local git config.
|
- Persists `with.token` in the local git config
|
||||||
- Enables your scripts to run authenticated git commands.
|
- Enables your scripts to run authenticated git commands
|
||||||
- Post-job cleanup removes the token.
|
- Post-job cleanup removes the token
|
||||||
- Coming soon: Opt out by setting `with.persist-credentials` to `false`.
|
- Coming soon: Opt out by setting `with.persist-credentials` to `false`
|
||||||
- Creates a local branch
|
- Creates a local branch
|
||||||
- No longer detached HEAD when checking out a branch.
|
- No longer detached HEAD when checking out a branch
|
||||||
- A local branch is created with the corresponding upstream branch set.
|
- A local branch is created with the corresponding upstream branch set
|
||||||
- Improved layout
|
- Improved layout
|
||||||
- `with.path` is always relative to `github.workspace`.
|
- `with.path` is always relative to `github.workspace`
|
||||||
- Aligns better with container actions, where `github.workspace` gets mapped in.
|
- Aligns better with container actions, where `github.workspace` gets mapped in
|
||||||
- Removed input `submodules`
|
- Removed input `submodules`
|
||||||
|
|
||||||
|
|
||||||
|
|
20
README.md
20
README.md
|
@ -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>
|
<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>
|
</p>
|
||||||
|
|
||||||
# Checkout V2 (preview)
|
# Checkout V2 (beta)
|
||||||
|
|
||||||
This action checks-out your repository under `$GITHUB_WORKSPACE`, so your workflow can access it.
|
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.
|
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.
|
Refer [here](https://github.com/actions/checkout/blob/v1/README.md) for previous versions.
|
||||||
|
|
||||||
# Usage
|
# Usage
|
||||||
|
|
||||||
<!-- start usage -->
|
<!-- start usage -->
|
||||||
```yaml
|
```yaml
|
||||||
- uses: actions/checkout@preview
|
- uses: actions/checkout@v2-beta
|
||||||
with:
|
with:
|
||||||
# Repository name
|
# Repository name
|
||||||
# Default: ${{ github.repository }}
|
# Default: ${{ github.repository }}
|
||||||
|
|
|
@ -96,7 +96,7 @@ function updateUsage(
|
||||||
}
|
}
|
||||||
|
|
||||||
updateUsage(
|
updateUsage(
|
||||||
'actions/checkout@preview',
|
'actions/checkout@v2-beta',
|
||||||
path.join(__dirname, '..', '..', 'action.yml'),
|
path.join(__dirname, '..', '..', 'action.yml'),
|
||||||
path.join(__dirname, '..', '..', 'README.md')
|
path.join(__dirname, '..', '..', 'README.md')
|
||||||
)
|
)
|
||||||
|
|
Loading…
Reference in a new issue