Skip to content
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.

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

docs: Add GitHub Actions documentation #955

Merged
merged 5 commits into from
Mar 11, 2024

Conversation

pavelzw
Copy link
Contributor

@pavelzw pavelzw commented Mar 11, 2024

as discussed in #950 (comment)

I copied everything from the setup-pixi readme and removed the Local development part and made it compatible with mkdocs.

We should make sure that every change to the documentation here will also be changed in the setup-pixi readme. xref prefix-dev/setup-pixi#84

```yaml
- uses: prefix-dev/setup-pixi@v0.5.1
with:
pixi-version: v0.16.1
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This technically would need to be updated on every version bump... But I guess it's not really bad if it lags behind a bit until new features that affect the action are announced.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will add it to the tbump run from the citation PR when that's in.

## Usage

```yaml
- uses: prefix-dev/setup-pixi@v0.5.1
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ideally this would be up to date with the setup-pixi version. I have some automation here to ensure this but it might be too much hassle to also maintain it in this repo. We can just wait until setup-pixi@v1.0.0 releases once pixi v1 releases and then use @v1 everywhere.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good to me!

docs/advanced/github_actions.md Outdated Show resolved Hide resolved
pavelzw and others added 3 commits March 11, 2024 16:04
@ruben-arts ruben-arts merged commit 8e606aa into prefix-dev:main Mar 11, 2024
5 checks passed
@pavelzw pavelzw deleted the docs-github-action branch March 11, 2024 15:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants