-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add better support for pyproject.toml pixi projects (#87)
Co-authored-by: Pavel Zwerschke <[email protected]>
- Loading branch information
1 parent
60414de
commit 632d179
Showing
11 changed files
with
7,629 additions
and
39 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -97,3 +97,6 @@ Thumbs.db | |
# Ignore built ts files | ||
__tests__/runner/* | ||
lib/**/* | ||
|
||
# Ignore jetbrains files | ||
.idea |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -23,7 +23,7 @@ GitHub Action to set up the [pixi](https://github.com/prefix-dev/pixi) package m | |
## Usage | ||
|
||
```yml | ||
- uses: prefix-dev/setup-pixi@v0.5.2 | ||
- uses: prefix-dev/setup-pixi@v0.6.0 | ||
with: | ||
pixi-version: v0.19.1 | ||
cache: true | ||
|
@@ -34,7 +34,7 @@ GitHub Action to set up the [pixi](https://github.com/prefix-dev/pixi) package m | |
> [!WARNING] | ||
> Since pixi is not yet stable, the API of this action may change between minor versions. | ||
> Please pin the versions of this action to a specific version (i.e., `prefix-dev/setup-pixi@v0.5.2`) to avoid breaking changes. | ||
> Please pin the versions of this action to a specific version (i.e., `prefix-dev/setup-pixi@v0.6.0`) to avoid breaking changes. | ||
> You can automatically update the version of this action by using [Dependabot](https://docs.github.com/en/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot). | ||
> | ||
> Put the following in your `.github/dependabot.yml` file to enable Dependabot for your GitHub Actions: | ||
|
@@ -73,7 +73,7 @@ In order to not exceed the [10 GB cache size limit](https://docs.github.com/en/a | |
This can be done by setting the `cache-write` argument. | ||
|
||
```yml | ||
- uses: prefix-dev/setup-pixi@v0.5.2 | ||
- uses: prefix-dev/setup-pixi@v0.6.0 | ||
with: | ||
cache: true | ||
cache-write: ${{ github.event_name == 'push' && github.ref_name == 'main' }} | ||
|
@@ -118,7 +118,7 @@ test: | |
environment: [py311, py312] | ||
steps: | ||
- uses: actions/checkout@v4 | ||
- uses: prefix-dev/setup-pixi@v0.5.2 | ||
- uses: prefix-dev/setup-pixi@v0.6.0 | ||
with: | ||
environments: ${{ matrix.environment }} | ||
``` | ||
|
@@ -128,7 +128,7 @@ test: | |
The following example will install both the `py311` and the `py312` environment on the runner. | ||
|
||
```yml | ||
- uses: prefix-dev/setup-pixi@v0.5.2 | ||
- uses: prefix-dev/setup-pixi@v0.6.0 | ||
with: | ||
# separated by spaces | ||
environments: >- | ||
|
@@ -163,7 +163,7 @@ Specify the token using the `auth-token` input argument. | |
This form of authentication (bearer token in the request headers) is mainly used at [prefix.dev](https://prefix.dev). | ||
|
||
```yml | ||
- uses: prefix-dev/setup-pixi@v0.5.2 | ||
- uses: prefix-dev/setup-pixi@v0.6.0 | ||
with: | ||
auth-host: prefix.dev | ||
auth-token: ${{ secrets.PREFIX_DEV_TOKEN }} | ||
|
@@ -175,7 +175,7 @@ Specify the username and password using the `auth-username` and `auth-password` | |
This form of authentication (HTTP Basic Auth) is used in some enterprise environments with [artifactory](https://jfrog.com/artifactory) for example. | ||
|
||
```yml | ||
- uses: prefix-dev/setup-pixi@v0.5.2 | ||
- uses: prefix-dev/setup-pixi@v0.6.0 | ||
with: | ||
auth-host: custom-artifactory.com | ||
auth-username: ${{ secrets.PIXI_USERNAME }} | ||
|
@@ -188,7 +188,7 @@ Specify the conda-token using the `conda-token` input argument. | |
This form of authentication (token is encoded in URL: `https://my-quetz-instance.com/t/<token>/get/custom-channel`) is used at [anaconda.org](https://anaconda.org) or with [quetz instances](https://github.com/mamba-org/quetz). | ||
|
||
```yml | ||
- uses: prefix-dev/setup-pixi@v0.5.2 | ||
- uses: prefix-dev/setup-pixi@v0.6.0 | ||
with: | ||
auth-host: anaconda.org # or my-quetz-instance.com | ||
conda-token: ${{ secrets.CONDA_TOKEN }} | ||
|
@@ -234,7 +234,7 @@ You can specify whether `setup-pixi` should run `pixi install --frozen` or `pixi | |
See the [official documentation](https://prefix.dev/docs/pixi/cli#install) for more information about the `--frozen` and `--locked` flags. | ||
|
||
```yml | ||
- uses: prefix-dev/setup-pixi@v0.5.2 | ||
- uses: prefix-dev/setup-pixi@v0.6.0 | ||
with: | ||
locked: true | ||
# or | ||
|
@@ -253,7 +253,7 @@ The first one is the debug logging of the action itself. | |
This can be enabled by running the action with the `RUNNER_DEBUG` environment variable set to `true`. | ||
|
||
```yml | ||
- uses: prefix-dev/setup-pixi@v0.5.2 | ||
- uses: prefix-dev/setup-pixi@v0.6.0 | ||
env: | ||
RUNNER_DEBUG: true | ||
``` | ||
|
@@ -271,7 +271,7 @@ The second type is the debug logging of the pixi executable. | |
This can be specified by setting the `log-level` input. | ||
|
||
```yml | ||
- uses: prefix-dev/setup-pixi@v0.5.2 | ||
- uses: prefix-dev/setup-pixi@v0.6.0 | ||
with: | ||
# one of `q`, `default`, `v`, `vv`, or `vvv`. | ||
log-level: vvv | ||
|
@@ -297,7 +297,7 @@ If nothing is specified, `post-cleanup` will default to `true`. | |
On self-hosted runners, you also might want to alter the default pixi install location to a temporary location. You can use `pixi-bin-path: ${{ runner.temp }}/bin/pixi` to do this. | ||
|
||
```yml | ||
- uses: prefix-dev/setup-pixi@v0.5.2 | ||
- uses: prefix-dev/setup-pixi@v0.6.0 | ||
with: | ||
post-cleanup: true | ||
# ${{ runner.temp }}\Scripts\pixi.exe on Windows | ||
|
@@ -307,13 +307,24 @@ On self-hosted runners, you also might want to alter the default pixi install lo | |
You can also use a preinstalled local version of pixi on the runner by not setting any of the `pixi-version`, | ||
`pixi-url` or `pixi-bin-path` inputs. This action will then try to find a local version of pixi in the runner's PATH. | ||
|
||
### Using the `pyproject.toml` as a manifest file for pixi. | ||
|
||
`setup-pixi` will automatically pick up the `pyproject.toml` if it contains a `[tool.pixi.project]` section and no `pixi.toml`. | ||
This can be overwritten by setting the `manifest-path` input argument. | ||
|
||
```yml | ||
- uses: prefix-dev/[email protected] | ||
with: | ||
manifest-path: pyproject.toml | ||
``` | ||
|
||
## More examples | ||
|
||
If you want to see more examples, you can take a look at the [GitHub Workflows of this repository](.github/workflows/test.yml). | ||
|
||
## Local Development | ||
|
||
1. Clone this repository. | ||
1. Run `pnpm install` inside the repository (if you don't have [`pnpm`](https://github.com/pnpm/pnpm) installed, you can install it with `npm install -g pnpm` or `brew install pnpm`). | ||
1. Run `pnpm dev` for live transpilation of the TypeScript source code. | ||
1. To test the action, you can run [`act`](https://github.com/nektos/act) (inside docker) or use :sparkles: CI driven development :sparkles:. | ||
2. Run `pnpm install` inside the repository (if you don't have [`pnpm`](https://github.com/pnpm/pnpm) installed, you can install it with `pixi global install pnpm`). | ||
3. Run `pnpm dev` for live transpilation of the TypeScript source code. | ||
4. To test the action, you can run [`act`](https://github.com/nektos/act) (inside docker) or use :sparkles: CI driven development :sparkles:. |
Oops, something went wrong.