checkout/action.yml
2026-02-05 10:30:21 +00:00

44 lines
1.5 KiB
YAML

name: 'Checkout'
description: 'Checkout a Git repository at a particular version'
inputs:
repository:
description: 'Repository name with owner. For example, actions/checkout'
default: ${{ forgejo.repository }}
ref:
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.
token:
description: >
Personal access token (PAT) used to fetch the repository.
default: ${{ forgejo.token }}
path:
description: 'Relative path under $GITHUB_WORKSPACE to place the repository'
default: .
fetch-depth:
description: 'Number of commits to fetch. 0 indicates all history for all branches and tags.'
default: 1
show-progress:
description: 'Whether to show progress status output when fetching.'
default: true
recurse-submodules:
description: >
Whether to recursively checkout submodules.
default: false
server-url:
description: >
The base URL for the git server that you are trying to clone from.
At the moment, only urls with `https` protocol are supported (no good reason, simpler url editing).
Example URLs are:
- https://github.com
- https://my-ghes-server.example.com
default: ${{ forgejo.server_url }}
required: false
runs:
using: composite
steps:
- run: ${{ forgejo.action_path }}/main.sh
shell: bash