mirror of https://github.com/actions/checkout.git
Add files via upload
This commit is contained in:
Emnmer1
GitHub
parent
273143575b
commit
a5b3296627
|
|
@ -0,0 +1,61 @@
|
||||||
|
# Changelog
|
||||||
|
|
||||||
|
## v3.0.0
|
||||||
|
|
||||||
|
- [Update to node 16](https://github.com/actions/checkout/pull/689)
|
||||||
|
|
||||||
|
## v2.3.1
|
||||||
|
|
||||||
|
- [Fix default branch resolution for .wiki and when using SSH](https://github.com/actions/checkout/pull/284)
|
||||||
|
|
||||||
|
## v2.3.0
|
||||||
|
|
||||||
|
- [Fallback to the default branch](https://github.com/actions/checkout/pull/278)
|
||||||
|
|
||||||
|
## v2.2.0
|
||||||
|
|
||||||
|
- [Fetch all history for all tags and branches when fetch-depth=0](https://github.com/actions/checkout/pull/258)
|
||||||
|
|
||||||
|
## v2.1.1
|
||||||
|
|
||||||
|
- Changes to support GHES ([here](https://github.com/actions/checkout/pull/236) and [here](https://github.com/actions/checkout/pull/248))
|
||||||
|
|
||||||
|
## v2.1.0
|
||||||
|
|
||||||
|
- [Group output](https://github.com/actions/checkout/pull/191)
|
||||||
|
- [Changes to support GHES alpha release](https://github.com/actions/checkout/pull/199)
|
||||||
|
- [Persist core.sshCommand for submodules](https://github.com/actions/checkout/pull/184)
|
||||||
|
- [Add support ssh](https://github.com/actions/checkout/pull/163)
|
||||||
|
- [Convert submodule SSH URL to HTTPS, when not using SSH](https://github.com/actions/checkout/pull/179)
|
||||||
|
- [Add submodule support](https://github.com/actions/checkout/pull/157)
|
||||||
|
- [Follow proxy settings](https://github.com/actions/checkout/pull/144)
|
||||||
|
- [Fix ref for pr closed event when a pr is merged](https://github.com/actions/checkout/pull/141)
|
||||||
|
- [Fix issue checking detached when git less than 2.22](https://github.com/actions/checkout/pull/128)
|
||||||
|
|
||||||
|
## v2.0.0
|
||||||
|
|
||||||
|
- [Do not pass cred on command line](https://github.com/actions/checkout/pull/108)
|
||||||
|
- [Add input persist-credentials](https://github.com/actions/checkout/pull/107)
|
||||||
|
- [Fallback to REST API to download repo](https://github.com/actions/checkout/pull/104)
|
||||||
|
|
||||||
|
## v2 (beta)
|
||||||
|
|
||||||
|
- 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`
|
||||||
|
|
||||||
|
|
||||||
|
## v1
|
||||||
|
|
||||||
|
Refer [here](https://github.com/actions/checkout/blob/v1/CHANGELOG.md) for the V1 changelog
|
||||||
|
|
@ -0,0 +1,36 @@
|
||||||
|
-----BEGIN PGP SIGNED MESSAGE-----
|
||||||
|
Hash: SHA256
|
||||||
|
|
||||||
|
Archive: Raspbian_10
|
||||||
|
Codename: Raspbian_10
|
||||||
|
Origin: obs://build.opensuse.org/devel:kubic:libcontainers:stable/Raspbian_10
|
||||||
|
Label: devel:kubic:libcontainers:stable
|
||||||
|
Architectures: armhf
|
||||||
|
Date: Wed Mar 16 13:23:56 2022
|
||||||
|
Description: Stable Releases of Upstream github.com/containers packages (Raspbian_10)
|
||||||
|
MD5Sum:
|
||||||
|
00da1553977a958c3908af1ba0b53aca 34187 Packages
|
||||||
|
25f9011747fdc99548ffb82ef6ad910a 8497 Packages.gz
|
||||||
|
5263d81ae22ea768594b67dda64de11a 21789 Sources
|
||||||
|
d575956d08185c9ae22ffdbc0008926c 6196 Sources.gz
|
||||||
|
SHA1:
|
||||||
|
7a14c49010851925c6d73077b6795c2e1b5ad2e0 34187 Packages
|
||||||
|
7d3104745bd34fb57b3e8280550a54f51691044f 8497 Packages.gz
|
||||||
|
51e00b51469e6e8efbef466d137ea8c8350343a9 21789 Sources
|
||||||
|
c606e67b2cb0685a1c82e03932585c57eb5d0d2e 6196 Sources.gz
|
||||||
|
SHA256:
|
||||||
|
47774476bc047c3a515a86a154f8b8a350933c4a584b5dcf116b4ff1b4e00195 34187 Packages
|
||||||
|
3e9e99a38156473bef2ba321610cb796bcdff0e2c964bad9ee54c6a4e35e0989 8497 Packages.gz
|
||||||
|
078616e1b3d43cc561a389d0fb4588a3e733e468496d920faf2cf786f4013eb1 21789 Sources
|
||||||
|
a15440ff40420e6b40a6e94fc2a3c3228735e0cbdb08c1ec7bec70aefeb3af62 6196 Sources.gz
|
||||||
|
-----BEGIN PGP SIGNATURE-----
|
||||||
|
Version: GnuPG v1.0.7 (GNU/Linux)
|
||||||
|
|
||||||
|
iQEVAwUBYjHk7E1kOQN1BgqkAQg/Ugf/aDxica0mCO/W1xUfw61cVhCgzi5IH9gk
|
||||||
|
lF/uCqeM9vVsEaW9oPtwOPrpA81ajkjZi/VvhOBTVYBGhQLLL83tGW5MAwC6CJDC
|
||||||
|
QCQPGd+YXlsgb6mR+S2d9zXILi6oEWpTQyTFxbI9GzyAke7uTY+a2vTSR/4YW86F
|
||||||
|
UI/PWpehWLUj09BKjOXR4/P5eqqe21ekiPZH+K2IL3ODAjA+6ZXl+X3s6/VFqQ5p
|
||||||
|
lO51eIgcekX5lYDiifxVvIcYnOhquWtJLsQxIuWLNokzqdRIPyGIj7uvRjTW6yky
|
||||||
|
QogFZ5+il0WLxrBWQmUQ4dxyVdcH4CyVOYGJhy2yn8CdRo+aLEpySQ==
|
||||||
|
=tKyt
|
||||||
|
-----END PGP SIGNATURE-----
|
||||||
|
|
@ -0,0 +1,224 @@
|
||||||
|
<p align="center">
|
||||||
|
<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 V3
|
||||||
|
|
||||||
|
This action checks-out your repository under `$GITHUB_WORKSPACE`, so your workflow can access it.
|
||||||
|
|
||||||
|
Only a single commit is fetched by default, for the ref/SHA that triggered the workflow. Set `fetch-depth: 0` to fetch all history for all branches and tags. Refer [here](https://help.github.com/en/articles/events-that-trigger-workflows) to learn which commit `$GITHUB_SHA` points to for different events.
|
||||||
|
|
||||||
|
The auth token is persisted in the local git config. This enables your scripts to run authenticated git commands. The token is removed during post-job cleanup. Set `persist-credentials: false` to opt-out.
|
||||||
|
|
||||||
|
When Git 2.18 or higher is not in your PATH, falls back to the REST API to download the files.
|
||||||
|
|
||||||
|
# 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.
|
||||||
|
|
||||||
|
# Usage
|
||||||
|
|
||||||
|
<!-- start usage -->
|
||||||
|
```yaml
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
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: ''
|
||||||
|
|
||||||
|
# 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: ''
|
||||||
|
|
||||||
|
# Number of commits to fetch. 0 indicates all history for all branches and tags.
|
||||||
|
# Default: 1
|
||||||
|
fetch-depth: ''
|
||||||
|
|
||||||
|
# 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
|
||||||
|
# `git@github.com:` are converted to HTTPS.
|
||||||
|
#
|
||||||
|
# Default: false
|
||||||
|
submodules: ''
|
||||||
|
```
|
||||||
|
<!-- end usage -->
|
||||||
|
|
||||||
|
# Scenarios
|
||||||
|
|
||||||
|
- [Fetch all history for all tags and branches](#Fetch-all-history-for-all-tags-and-branches)
|
||||||
|
- [Checkout a different branch](#Checkout-a-different-branch)
|
||||||
|
- [Checkout HEAD^](#Checkout-HEAD)
|
||||||
|
- [Checkout multiple repos (side by side)](#Checkout-multiple-repos-side-by-side)
|
||||||
|
- [Checkout multiple repos (nested)](#Checkout-multiple-repos-nested)
|
||||||
|
- [Checkout multiple repos (private)](#Checkout-multiple-repos-private)
|
||||||
|
- [Checkout pull request HEAD commit instead of merge commit](#Checkout-pull-request-HEAD-commit-instead-of-merge-commit)
|
||||||
|
- [Checkout pull request on closed event](#Checkout-pull-request-on-closed-event)
|
||||||
|
- [Push a commit using the built-in token](#Push-a-commit-using-the-built-in-token)
|
||||||
|
|
||||||
|
## Fetch all history for all tags and branches
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
```
|
||||||
|
|
||||||
|
## Checkout a different branch
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
with:
|
||||||
|
ref: my-branch
|
||||||
|
```
|
||||||
|
|
||||||
|
## Checkout HEAD^
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
with:
|
||||||
|
fetch-depth: 2
|
||||||
|
- run: git checkout HEAD^
|
||||||
|
```
|
||||||
|
|
||||||
|
## Checkout multiple repos (side by side)
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v3
|
||||||
|
with:
|
||||||
|
path: main
|
||||||
|
|
||||||
|
- name: Checkout tools repo
|
||||||
|
uses: actions/checkout@v3
|
||||||
|
with:
|
||||||
|
repository: my-org/my-tools
|
||||||
|
path: my-tools
|
||||||
|
```
|
||||||
|
|
||||||
|
## Checkout multiple repos (nested)
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Checkout tools repo
|
||||||
|
uses: actions/checkout@v3
|
||||||
|
with:
|
||||||
|
repository: my-org/my-tools
|
||||||
|
path: my-tools
|
||||||
|
```
|
||||||
|
|
||||||
|
## Checkout multiple repos (private)
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v3
|
||||||
|
with:
|
||||||
|
path: main
|
||||||
|
|
||||||
|
- name: Checkout private tools
|
||||||
|
uses: actions/checkout@v3
|
||||||
|
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 }}` is scoped to the current repository, so if you want to checkout a different repository that is private you will need to provide your own [PAT](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line).
|
||||||
|
|
||||||
|
|
||||||
|
## Checkout pull request HEAD commit instead of merge commit
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
with:
|
||||||
|
ref: ${{ github.event.pull_request.head.sha }}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Checkout pull request on closed event
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
on:
|
||||||
|
pull_request:
|
||||||
|
branches: [main]
|
||||||
|
types: [opened, synchronize, closed]
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
```
|
||||||
|
|
||||||
|
## Push a commit using the built-in token
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
on: push
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
- run: |
|
||||||
|
date > generated.txt
|
||||||
|
git config user.name github-actions
|
||||||
|
git config user.email github-actions@github.com
|
||||||
|
git add .
|
||||||
|
git commit -m "generated"
|
||||||
|
git push
|
||||||
|
```
|
||||||
|
|
||||||
|
# License
|
||||||
|
|
||||||
|
The scripts and documentation in this project are released under the [MIT License](LICENSE)
|
||||||
Loading…
Reference in New Issue