Skip to content

Commit ca3107b

Browse files
committed
improved docs after feedback
1 parent fa0d132 commit ca3107b

File tree

2 files changed

+14
-7
lines changed

2 files changed

+14
-7
lines changed

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,22 @@
11
# linuxkit-build
2-
A Github action to enable LinuxKit OS image builds
2+
A Github action to enable [LinuxKit](https://github.com/linuxkit/linuxkit) OS image builds
3+
4+
LinuxKit describes itself as:
5+
> A toolkit for building secure, portable and lean operating systems for containers
6+
7+
This action relies on a [Docker image of LinuxKit](https://hub.docker.com/repository/docker/vouchio/linuxkit-docker)
38

49
## Inputs
510

611
### `config`
712

8-
**Required** LinuxKit YAML configuration to build (eg lxk-build.yml). There is no default.
13+
**Required** LinuxKit YAML file(s) to build (eg `lxk.yml`). There is no default.
914

1015
### `format`
1116

12-
**Optional** The format for the output (eg `aws`, `gcp`, `iso-efi`, etc...).
17+
**Optional** The format(s) for the output (eg `aws`, `gcp`, `iso-efi`, etc...).
1318

14-
**Default** `kernel+initrd`
19+
**Default:** `kernel+initrd`
1520

1621
## Outputs
1722

@@ -22,15 +27,17 @@ The files that were built
2227
## Example usage - default
2328

2429
```yaml
25-
uses: actions/linuxkit-docker-action@v1
30+
# Check the action marketplace for the latest version tag
31+
uses: actions/[email protected]
2632
with:
2733
config: lxk-build.yml
2834
```
2935
3036
## Example usage - AWS
3137
3238
```yaml
33-
uses: actions/linuxkit-docker-action@v1
39+
# Check the action marketplace for the latest version tag
40+
uses: actions/[email protected]
3441
with:
3542
config: lxk-build.yml
3643
format: aws

action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ branding:
66
color: purple
77
inputs:
88
config:
9-
description: 'LinuxKit YAML configuration to build (eg lxk-build.yml)'
9+
description: 'LinuxKit YAML configuration file(s) (eg lxk-build.yml)'
1010
required: true
1111
format:
1212
description: 'The output format (eg aws, gcp, iso-efi, etc...)'

0 commit comments

Comments
 (0)