collection/checkout/action.yml

48 lines
1.7 KiB
YAML
Raw Normal View History

2026-07-11 17:02:18 +02:00
# SPDX-License-Identifier: EUPL-1.2
name: "checkout"
description: "Checkout a git repository at a particular version"
author: "Louis Seubert"
inputs:
repository:
required: false
description: >
The path to the repository to checkout. Must be accessible with the
pipeline token or publicly. Can be either an HTTPS or SSH URL.
default: "${{ forgejo.server_url }}/${{ forgejo.repository }}.git"
ref:
required: false
description: >
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.
default: "${{ forgejo.ref || forgejo.sha }}"
path:
required: false
description: >
The directory to checkout the repository into. If the directory does not
exist, it will be created.
default: "${{ forgejo.workspace }}"
depth:
required: false
description: >
Create a shallow clone with a history truncated to the specified number of
commits. If the repository contains submodules, these are also cloned
shallowly. A value of `0` implies no shallow cloning.
default: "0"
submodule:
required: false
description: >
After the clone is created, initialize and clone submodules within based
on the provided configuration.
default: "false"
filter:
required: false
description: >
Use the partial clone feature and request that the server sends a subset
of reachable objects according to a given object filter. The default value
is `auto` to allow the server to decide.
default: "auto"
runs:
using: "docker"
image: "docker://code.geekeey.de/component/core:1.0.0"
args: [ "checkout" ]