Skip to content

Update README #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
VeckoTheGecko merged 1 commit into from
Aug 4, 2026
Merged

Update README #22

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,11 @@ jobs:

#### `create-and-cache`

| Input | Description | Required | Default |
| -------------- | ------------------------------------------------------- | -------- | -------------------------------- |
| `pixi-version` | Version of pixi to use for generating the lock file | No | `latest` |
| `hash-files` | Files to use to generate the hash key for the lock file | No | `pixi.toml` and `pyproject.toml` |
| Input | Description | Required | Default |
| --------------- | ------------------------------------------------------- | -------- | --------------------------------------------- |
| `pixi-version` | Version of pixi to use for generating the lock file | No | `latest` |
| `hash-files` | Files to use to generate the hash key for the lock file | No | `pixi.toml` and `pyproject.toml` |
| `manifest-path` | Path to the manifest file to use for the pixi CLI. | No | `pixi.toml`, falling back to `pyproject.toml` |

| Output | Description |
| -------------- | ------------------------------------- |
Expand All @@ -66,9 +67,10 @@ jobs:

#### `restore`

| Input | Description | Required |
| ----------- | ------------------------------------- | -------- |
| `cache-key` | The cache key from `create-and-cache` | Yes |
| Input | Description | Required | Default |
| --------------- | -------------------------------------------------- | -------- | --------------------------------------------- |
| `cache-key` | The cache key from `create-and-cache` | Yes | - |
| `manifest-path` | Path to the manifest file to use for the pixi CLI. | No | `pixi.toml`, falling back to `pyproject.toml` |

> [!NOTE]
> The cache key includes the current date, so the lock file is regenerated daily.
Expand Down
Loading