Files
checkout/README.md

26 lines
883 B
Markdown

# actions/checkout
A lightweight checkout action for Gitea Actions, including support for Gitea instances served from a URL subpath (for example `https://host/git`).
## Usage
```yaml
- name: Checkout
uses: https://git.campbellwireless.net/actions/checkout@v1
with:
server-url: https://cloud.campbellwireless.net/git
```
## Inputs
- `server-url` (required): base server URL. Include subpath if your Gitea is not at root.
- `repository` (optional): `owner/name`, defaults to `${{ github.repository }}`.
- `ref` (optional): branch/tag/SHA, defaults to `${{ github.sha }}`.
- `token` (optional): auth token, defaults to `${{ secrets.GITHUB_TOKEN }}`.
- `path` (optional): checkout destination under workspace, defaults to `.`.
- `fetch-depth` (optional): number of commits to fetch, defaults to `1`; set `0` for full history.
## Output
- `commit`: checked out commit SHA.