Skip to content

Commit

Permalink
Add link to example workflow (#7)
Browse files Browse the repository at this point in the history
  • Loading branch information
eifinger authored Aug 25, 2024
1 parent 19a0b38 commit c69e1d6
Showing 1 changed file with 5 additions and 7 deletions.
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Set up your GitHub Actions workflow with a specific version of [uv](https://docs

## 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

Expand Down Expand Up @@ -115,15 +115,15 @@ The cache will be invalidated if any file matching the glob pattern changes.
The glob matches files relative to the repository root.

```yaml
- name: Define a custom cache dependency glob
- name: Define a cache dependency glob
uses: eifinger/setup-uv@v1
with:
enable-cache: true
cache-dependency-glob: 'uv.lock'
```

```yaml
- name: Define a custom cache dependency glob
- name: Define a cache dependency glob
uses: eifinger/setup-uv@v1
with:
enable-cache: true
Expand Down Expand Up @@ -162,10 +162,8 @@ A simple example workflow could look like this:
uses: eifinger/setup-uv@v1
with:
enable-cache: true
- name: Sync dependencies
run: uv sync
- name: Test
run: uv run pytest
run: uv run --frozen pytest
```

### What is the default version?
Expand All @@ -177,7 +175,7 @@ If you have to know the version installed for other steps of your workflow you c

```yaml
- name: Checkout the repository
uses: actions/checkout@latest
uses: actions/checkout@main
- name: Install the default version of uv
id: setup-uv
uses: eifinger/setup-uv@v1
Expand Down

0 comments on commit c69e1d6

Please sign in to comment.