Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pvizeli committed Jun 23, 2023
1 parent 03d9574 commit 90182b9
Showing 1 changed file with 25 additions and 3 deletions.
28 changes: 25 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,22 @@ You can use this repository as a GitHub action to test and/or publish your build

Use the `with.args` key to pass in arguments to the builder, to see what arguments are supported you can look at the [arguments](#Arguments) section.

For [CAS](https://cas.codenotary.com/) support, add `env.CAS_API_KEY` which would allow you to use the `codenotary` properties from `build` configs.
### Cosign support

You can use cosign to signing and verify the build chain. To sign the image, use `--cosign` and attach following options to the github action:

```yaml
jobs:
build:
name: Test build
runs-on: ubuntu-latest
permissions:
contents: read
packages: write
id-token: write
```
For keep a trust-chain during the built, you need set `identity` and `base_identity` to your build.yml

### Test action example

Expand Down Expand Up @@ -70,13 +85,15 @@ jobs:
Options:
-h, --help
Display this help and exit.

Repository / Data
-r, --repository <REPOSITORY>
Set git repository to load data from.
-b, --branch <BRANCH>
Set git branch for repository.
-t, --target <PATH_TO_BUILD>
Set local folder or path inside repository for build.

Version/Image handling
-v, --version <VERSION>
Overwrite version/tag of build.
Expand All @@ -90,6 +107,7 @@ Options:
Add additional tags that will be published
--version-from <VERSION>
Use this to set build_from tag if not specified.

Architecture
--armhf
Build for arm v6.
Expand All @@ -103,6 +121,7 @@ Options:
Build for intel/amd 32bit.
--all
Build all architecture.

Build handling
--test
Disable push to dockerhub.
Expand All @@ -122,8 +141,10 @@ Options:
Username to login into docker with
--docker-password <PASSWORD>
Password to login into docker with

Use the host docker socket if mapped into container:
/var/run/docker.sock

Internals:
--addon
Default on. Run all things for an addon build.
Expand All @@ -133,9 +154,10 @@ Options:
Build our base images.
--machine <VERSION=ALL,X,Y>
Build the machine based image for a release/landingpage.

Security:
Enable signing images with Codenotary. Need set follow env:
- CAS_API_KEY
--cosign
Enable signing images with cosign.
```
## Local installation
Expand Down

0 comments on commit 90182b9

Please sign in to comment.