Skip to content

Commit 4f014e2

Browse files
authored
docs: Update action version in github_action.md (#1449)
## Summary Update the version listed, and link to the GitHub Marketplace page in order to avoid needing to duplicate its configuration table. As a bonus, fix capitalization of GitHub. Signed-off-by: Adam DiCarlo <[email protected]>
1 parent 27be737 commit 4f014e2

File tree

1 file changed

+8
-25
lines changed

1 file changed

+8
-25
lines changed
Lines changed: 8 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
---
2-
title: Using Devbox in CI/CD with Github Actions
2+
title: Using Devbox in CI/CD with GitHub Actions
33
---
44

5-
This guide explains how to use Devbox in CI/CD using Github Actions. The [devbox-install-action](https://github.com/marketplace/actions/devbox-installer) will install Devbox CLI and any packages + configuration defined in your `devbox.json` file. You can then run tasks or scripts within `devbox shell` to reproduce your environment.
5+
This guide explains how to use Devbox in CI/CD using GitHub Actions. The [devbox-install-action](https://github.com/marketplace/actions/devbox-installer) will install Devbox CLI and any packages + configuration defined in your `devbox.json` file. You can then run tasks or scripts within `devbox shell` to reproduce your environment.
66

7-
This Github Action also supports caching the packages and dependencies installed in your `devbox.json`, which can significantly improve CI build times.
7+
This GitHub Action also supports caching the packages and dependencies installed in your `devbox.json`, which can significantly improve CI build times.
88

99
## Usage
1010

11-
`devbox-install-action` is available on the [Github Marketplace](https://github.com/marketplace/actions/devbox-installer)
11+
`devbox-install-action` is available on the [GitHub Marketplace](https://github.com/marketplace/actions/devbox-installer)
1212

1313
In your project's workflow YAML, add the following step:
1414

1515
```yaml
1616
- name: Install devbox
17-
uses: jetpack-io/devbox-install-action@v0.2.0
17+
uses: jetpack-io/devbox-install-action@v0.6.0
1818
```
1919
2020
## Example Workflow
@@ -33,7 +33,7 @@ jobs:
3333
- uses: actions/checkout@v3
3434

3535
- name: Install devbox
36-
uses: jetpack-io/devbox-install-action@v0.2.0
36+
uses: jetpack-io/devbox-install-action@v0.6.0
3737

3838
- name: Run arbitrary commands
3939
run: devbox run -- echo "done!"
@@ -42,23 +42,6 @@ jobs:
4242
run: devbox run test
4343
```
4444
45-
## Configuring the Github Action
45+
## Configuring the Action
4646
47-
The `devbox-install-action` provides the following inputs:
48-
49-
| Input Argument| Description| Default|
50-
| :- | :- | :- |
51-
|`project-path` | Path to the folder that contains a valid devbox.json | Root directory of your repo
52-
|`enable-cache` | Caches the entire Nix store (your packages) in Github based on your `devbox.json`.|
53-
|`devbox-version`| Pins a specific version of the Devbox CLI for your action. Only supports >0.2.2| latest|
54-
55-
An example of this configuration is below:
56-
57-
```yaml
58-
- name: Install devbox
59-
uses: jetpack-io/[email protected]
60-
with:
61-
project-path: 'path-to-folder'
62-
enable-cache: true
63-
devbox-version: '0.2.2'
64-
```
47+
See the [GitHub Marketplace page](https://github.com/marketplace/actions/devbox-installer) for the latest configuration settings and an example.

0 commit comments

Comments
 (0)