Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
colek42 committed Oct 31, 2022
1 parent c6b3d9b commit 9cea771
Show file tree
Hide file tree
Showing 4 changed files with 77 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ jobs:
name: test intoto-run
steps:
- uses: actions/checkout@v2
- uses: testifysec/intoto-run-action@main
- uses: in-toto/github-action@main
name: intoto run command
with:
step-name: 'test'
Expand Down
31 changes: 31 additions & 0 deletions GOVERNANCE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# in-toto governance
This document covers the project's governance and committer process. The
project consists of the in-toto
[specification](https://github.com/in-toto/docs) and
[reference implementation](https://github.com/in-toto/in-toto).

## Maintainership and Consensus Builder
The project is maintained by the people indicated in
[MAINTAINERS.txt](MAINTAINERS.txt). A maintainer is expected to (1) submit and
review GitHub pull requests and (2) open issues or [submit vulnerability
reports](https://github.com/in-toto/in-toto#security-issues-and-bugs).
A maintainer has the authority to approve or reject pull requests submitted by
contributors. The project's Consensus Builder (CB) is
Santiago Torres-Arias <[email protected], @santiagotorres>.

## Contributions
A contributor can submit GitHub pull requests to the project's repositories.
They must follow the project's [code of
conduct](CODE-OF-CONDUCT.md), the [Developer Certificate of
Origin (DCO)](https://developercertificate.org/) and the [code style
guidelines](https://github.com/secure-systems-lab/code-style-guidelines), and
they must unit test any new software feature or change. Submitted pull
requests undergo review and automated testing.

## Changes in maintainership

A contributor to the project must express interest in becoming a maintainer.
The CB has the authority to add or remove maintainers.

## Changes in governance
The CB supervises changes in governance.
45 changes: 44 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,45 @@
# This Action is a wrapper for in-toto run. It runs the command passed to it and records the files that were created or modified during the run.
# in-toto-run action

This is a wrapper for the in-toto-run command. It is intended to be used by
developers to wrap the commands that are performed as part of their software
supply chain. The wrapper will record metadata for the passed command.

## Example Usage

```yaml

on: [push]
permissions:
id-token: write # This is required for requesting the JWT
contents: read # This is required for actions/checkout
jobs:
test:
runs-on: ubuntu-latest
name: test intoto-run
steps:
- uses: actions/checkout@v2
- uses: testifysec/intoto-run-action@main
name: intoto run command
with:
step-name: 'test'
private-key: |
-----BEGIN PRIVATE KEY-----
MC4CAQAwBQYDK2VwBCIEIOl8ZskJnvzzBzudkifLO9EPu8Nuy9+eo8ryIZ7cVbwF
-----END PRIVATE KEY-----
command: touch test.txt
products: 'test.txt'
exclude: "node_modules/"
- name: show-attestation
run: cat $RUNNER_TEMP/meta/*.link
```
## Roadmap
- [ ] Add support for multiple commands
- [ ] Intgration with Fulcio for signing attestations
- [ ] Upload link meta-data to Archivist
## Contributing
Contributions are welcome! Please see our [contributing guidelines](GOVERNANCE.md).
```
2 changes: 1 addition & 1 deletion action.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

name: intoto-run
name: in-toto-run
description: 'Creates Attesttion of CI Process'
inputs:
step-name:
Expand Down

0 comments on commit 9cea771

Please sign in to comment.