Add link to example workflow

This commit is contained in:
Kevin Stillhammer 2024-08-25 16:18:25 +02:00
parent 19a0b38226
commit dc92027fb3
No known key found for this signature in database

View File

@ -23,7 +23,7 @@ Set up your GitHub Actions workflow with a specific version of [uv](https://docs
## Usage ## Usage
Example workflow will be added later Example workflow in a real world project can be found [here](https://github.com/eifinger/hass-weenect/blob/main/.github/workflows/ci.yml)
### Install specific version ### Install specific version
@ -115,7 +115,7 @@ The cache will be invalidated if any file matching the glob pattern changes.
The glob matches files relative to the repository root. The glob matches files relative to the repository root.
```yaml ```yaml
- name: Define a custom cache dependency glob - name: Define a cache dependency glob
uses: eifinger/setup-uv@v1 uses: eifinger/setup-uv@v1
with: with:
enable-cache: true enable-cache: true
@ -123,7 +123,7 @@ The glob matches files relative to the repository root.
``` ```
```yaml ```yaml
- name: Define a custom cache dependency glob - name: Define a cache dependency glob
uses: eifinger/setup-uv@v1 uses: eifinger/setup-uv@v1
with: with:
enable-cache: true enable-cache: true
@ -162,10 +162,8 @@ A simple example workflow could look like this:
uses: eifinger/setup-uv@v1 uses: eifinger/setup-uv@v1
with: with:
enable-cache: true enable-cache: true
- name: Sync dependencies
run: uv sync
- name: Test - name: Test
run: uv run pytest run: uv run --frozen pytest
``` ```
### What is the default version? ### What is the default version?
@ -177,7 +175,7 @@ If you have to know the version installed for other steps of your workflow you c
```yaml ```yaml
- name: Checkout the repository - name: Checkout the repository
uses: actions/checkout@latest uses: actions/checkout@main
- name: Install the default version of uv - name: Install the default version of uv
id: setup-uv id: setup-uv
uses: eifinger/setup-uv@v1 uses: eifinger/setup-uv@v1