An open API service indexing awesome lists of open source software.

https://github.com/slsa-framework/example-package


https://github.com/slsa-framework/example-package

Last synced: 4 months ago
JSON representation

Awesome Lists containing this project

README

          

# Example project for SLSA

Example project builds a simple binary using a variety of [SLSA]-compliant
builders.

The code is built using `bazelisk build`:

- Bazelisk reads [.bazelversion], fetches the correct version of Bazel, and
then runs `bazel build`.
- Bazel reads [WORKSPACE], fetches the rules_go module, and then compiles the
`hello` binary.

For GitHub Actions-based builds, the artifact is uploaded using
[actions/upload-artifact].

[.bazelversion]: .bazelversion
[SLSA]: https://slsa.dev
[WORKSPACE]: WORKSPACE
[actions/upload-artifact]: https://github.com/actions/upload-artifact

## Builders

- [github-actions-demo.yaml](.github/workflows/github-actions-demo.yaml)
([results](https://github.com/slsa-framework/example-package/actions/workflows/github-actions-demo.yaml)):
SLSA 1 provenance generated on GitHub Actions using
https://github.com/slsa-framework/github-actions-demo.
- [slsa-github-generator.yaml](.github/workflows/slsa-github-generator.yaml)
([results](https://github.com/slsa-framework/example-package/actions/workflows/slsa-github-generator.yaml)):
SLSA 2 provenance generated on GitHub Actions using
https://github.com/slsa-framework/slsa-github-generator.

## slsa-github-generator e2e test status

### Project health

[![golangci-lint](https://github.com/slsa-framework/example-package/actions/workflows/pre-submit.golangci-lint.yml/badge.svg)](https://github.com/slsa-framework/example-package/actions/workflows/pre-submit.golangci-lint.yml) [![shellcheck](https://github.com/slsa-framework/example-package/actions/workflows/pre-submit.shellcheck.yml/badge.svg)](https://github.com/slsa-framework/example-package/actions/workflows/pre-submit.shellcheck.yml) [![yamllint](https://github.com/slsa-framework/example-package/actions/workflows/pre-submit.yamllint.yml/badge.svg)](https://github.com/slsa-framework/example-package/actions/workflows/pre-submit.yamllint.yml) [![actionlint](https://github.com/slsa-framework/example-package/actions/workflows/pre-submit.actionlint.yml/badge.svg)](https://github.com/slsa-framework/example-package/actions/workflows/pre-submit.actionlint.yml)

### Node.js builder e2e tests



Event
Name
Status




create

.github/workflows/e2e.nodejs.create.main.default.slsa3.yml


push
default branch
.github/workflows/e2e.nodejs.push.main.default.slsa3.yml


custom publish
.github/workflows/e2e.nodejs.push.main.custom_publish.slsa3.yml


Node 16
.github/workflows/e2e.nodejs.push.main.node16.slsa3.yml


Node 18
.github/workflows/e2e.nodejs.push.main.node18.slsa3.yml


npm dist-tag
.github/workflows/e2e.nodejs.push.main.disttag.slsa3.yml


non-default branch
.github/workflows/e2e.nodejs.push.branch1.default.slsa3.yml


push to tag
.github/workflows/e2e.nodejs.tag.main.default.slsa3.yml


push to tag (unscoped package)
.github/workflows/e2e.nodejs.tag.main.unscoped.slsa3.yml


release

.github/workflows/e2e.nodejs.release.main.default.slsa3.yml


workflow_dispatch

.github/workflows/e2e.nodejs.workflow_dispatch.main.default.slsa3.yml

### BYOB generic permissions builder e2e tests



Event
Name
Status




create
default
.github/workflows/e2e.delegator-generic.create.main.default.slsa3.yml


with sha1
.github/workflows/e2e.delegator-generic.create.main.checkout.slsa3.yml


push
default branch
.github/workflows/e2e.delegator-generic.push.main.default.slsa3.yml


push to tag
.github/workflows/e2e.delegator-generic.tag.main.default.slsa3.yml


release
default
.github/workflows/e2e.delegator-generic.release.main.default.slsa3.yml


With sha1
.github/workflows/e2e.delegator-generic.release.main.checkout.slsa3.yml


workflow_dispatch
default branch
.github/workflows/e2e.delegator-generic.workflow_dispatch.main.default.slsa3.yml


default branch w/ sha1
.github/workflows/e2e.delegator-generic.workflow_dispatch.main.checkout.slsa3.yml


non-default branch
.github/workflows/e2e.delegator-generic.workflow_dispatch.branch1.default.slsa3.yml


non-default branch w/ sha1
.github/workflows/e2e.delegator-generic.workflow_dispatch.branch1.checkout.slsa3.yml

### BYOB low permissions builder e2e tests

| Event | Status |
| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| workflow_dispatch | [![.github/workflows/e2e.delegator-lowperms.workflow_dispatch.main.default.slsa3.yml](https://github.com/slsa-framework/example-package/actions/workflows/e2e.delegator-lowperms.workflow_dispatch.main.default.slsa3.yml/badge.svg?event=workflow_dispatch)](https://github.com/slsa-framework/example-package/actions/workflows/e2e.delegator-lowperms.workflow_dispatch.main.default.slsa3.yml) |
| release | [![.github/workflows/e2e.delegator-lowperms.release.main.default.slsa3.yml](https://github.com/slsa-framework/example-package/actions/workflows/e2e.delegator-lowperms.release.main.default.slsa3.yml/badge.svg)](https://github.com/slsa-framework/example-package/actions/workflows/e2e.delegator-lowperms.release.main.default.slsa3.yml) |
| create | [![.github/workflows/e2e.delegator-lowperms.create.main.default.slsa3.yml](https://github.com/slsa-framework/example-package/actions/workflows/e2e.delegator-lowperms.create.main.default.slsa3.yml/badge.svg)](https://github.com/slsa-framework/example-package/actions/workflows/e2e.delegator-lowperms.create.main.default.slsa3.yml) |
| push | [![.github/workflows/e2e.delegator-lowperms.push.main.default.slsa3.yml](https://github.com/slsa-framework/example-package/actions/workflows/e2e.delegator-lowperms.push.main.default.slsa3.yml/badge.svg?event=push)](https://github.com/slsa-framework/example-package/actions/workflows/e2e.delegator-lowperms.push.main.default.slsa3.yml) |
| tag | [![.github/workflows/e2e.delegator-lowperms.tag.main.default.slsa3.yml](https://github.com/slsa-framework/example-package/actions/workflows/e2e.delegator-lowperms.tag.main.default.slsa3.yml/badge.svg?event=push)](https://github.com/slsa-framework/example-package/actions/workflows/e2e.delegator-lowperms.tag.main.default.slsa3.yml) |