Skip to content

Commit

Permalink
docs: update README for v1.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
dhth committed Aug 18, 2024
1 parent 28981de commit cfbb8f4
Showing 1 changed file with 24 additions and 14 deletions.
38 changes: 24 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,18 @@ gh api repos/<OWNER>/<REPO>/actions/workflows
# use node_id from the response
```

### Tabular output

`act3` can also output results in a tabular format.

```bash
act3 -f table
```

<p align="center">
<img src="https://tools.dhruvs.space/images/act3/act3-2.png" alt="Usage" />
</p>

### HTML output

`act3` can also output results in HTML format. You can also specify a template
Expand All @@ -114,9 +126,7 @@ using the `-t` flag (refer to
default template.)

```bash
act3" \
-f html \
-t path/to/template/file.html
act3 -f html
```

The resultant HTML page looks like this.
Expand All @@ -136,36 +146,36 @@ verify its authenticity. Checksums are applied to all released artifacts, and
the resulting checksum file is signed using
[cosign](https://docs.sigstore.dev/cosign/installation/).

Steps to verify (replace the version in the commands listed with the one you
want):
Steps to verify (replace `x.y.z` in the commands listed below with the version
you want):

1. Download the following files from the release:

- act3_1.0.0_checksums.txt
- act3_1.0.0_checksums.txt.pem
- act3_1.0.0_checksums.txt.sig
- act3_x.y.z_checksums.txt
- act3_x.y.z_checksums.txt.pem
- act3_x.y.z_checksums.txt.sig

2. Verify the signature:

```shell
cosign verify-blob act3_1.0.0_checksums.txt \
--certificate act3_1.0.0_checksums.txt.pem \
--signature act3_1.0.0_checksums.txt.sig \
cosign verify-blob act3_x.y.z_checksums.txt \
--certificate act3_x.y.z_checksums.txt.pem \
--signature act3_x.y.z_checksums.txt.sig \
--certificate-identity-regexp 'https://github\.com/dhth/act3/\.github/workflows/.+' \
--certificate-oidc-issuer "https://token.actions.githubusercontent.com"
```

3. Download the compressed archive you want, and validate its checksum:

```shell
curl -sSLO https://github.com/dhth/act3/releases/download/v1.0.0/act3_1.0.0_linux_amd64.tar.gz
sha256sum --ignore-missing -c act3_1.0.0_checksums.txt
curl -sSLO https://github.com/dhth/act3/releases/download/vx.y.z/act3_x.y.z_linux_amd64.tar.gz
sha256sum --ignore-missing -c act3_x.y.z_checksums.txt
```

3. If checksum validation goes through, uncompress the archive:

```shell
tar -xzf act3_1.0.0_linux_amd64.tar.gz
tar -xzf act3_x.y.z_linux_amd64.tar.gz
./act3
# profit!
```
Expand Down

0 comments on commit cfbb8f4

Please sign in to comment.