Skip to content

Commit 3e22828

Browse files
committed
docs: update
Signed-off-by: Carlos Alexandro Becker <[email protected]>
1 parent bcdbf95 commit 3e22828

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

README.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -26,16 +26,17 @@ There's much more you can change, these are the things I usually do.
2626

2727
### GoReleaser Configuration
2828

29-
The [provided configuration](./.goreleaser.yaml) is commented out and each section
30-
links to the relevant documentation, but here's a rundown:
31-
32-
- we build for a couple of platforms using the Go mod proxy
33-
- we create archives for both the binaries as well as for the source
34-
- we create and sign a checksums file (using [Cosign][cosign])
35-
- we create SBOMs of all archives (using [Syft][syft])
36-
- all these files are uploaded to the GitHub release
37-
- we create a Docker image manifest, which also includes SBOMs
38-
- we then sign the image
29+
The [provided configuration](./.goreleaser.yaml) is commented out and each
30+
section links to the relevant documentation, but here's a rundown:
31+
32+
1. We build for a couple of platforms using the Go mod proxy;
33+
1. We create archives for both the binaries as well as for the source;
34+
1. We create and sign a checksums file (using [Cosign][cosign]);
35+
1. We create [Software Bill of Materials (SBOMs)](https://www.cisa.gov/sbom)
36+
for all the archives (using [Syft][syft]);
37+
1. all these files are uploaded to the GitHub release;
38+
1. We create a Docker image manifest, which also includes SBOMs;
39+
1. We then sign the image.
3940

4041
### GitHub Actions
4142

@@ -51,8 +52,8 @@ out the code, installs Go, and runs `go test`.
5152
The [security workflow](./.github/workflows/security.yml) does a lot more, as it
5253
has a couple of jobs:
5354

54-
1. `codeql`: as the name implies, runs the recommended [CodeQL][codeql] queries for Go and
55-
Actions;
55+
1. `codeql`: as the name implies, runs the recommended [CodeQL][codeql] queries
56+
for Go and Actions;
5657
1. `grype`: runs [Grype][], which scans for known vulnerabilities;
5758
1. `govulncheck`: runs the standard [Go vulnerability checker][govulncheck];
5859
1. `dependency-review`: runs only on pull requests, and checks if any

0 commit comments

Comments
 (0)