Skip to content

Commit

Permalink
Update README.md - fix bug and add examples headings (#62)
Browse files Browse the repository at this point in the history
- fix typo in `setup` action example (`endoctl` -> `endorctl`)
- add headings for examples for easy linking
  • Loading branch information
darrenpmeyer authored Jul 24, 2024
1 parent 802fa65 commit e4ee275
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ The following pre-requisites are required for the Endor Labs GitHub action to su
4. Build your code
5. Scan or Sign with Endor Labs

### Example: scan a Java Application (keyless auth)

Below is an example workflow to scan with Endor Labs for a Java application using the recommended keyless authentication for GitHub actions:

```yaml
Expand Down Expand Up @@ -53,6 +55,8 @@ jobs:
namespace: "example"
```
### Example: sign a container image
Below is an example workflow to sign with Endor Labs:
```yaml
Expand Down Expand Up @@ -89,6 +93,8 @@ jobs:
namespace: "example"
```
### Example: deploy `endorctl` and use it in a shell script

Below is an example workflow to setup Endorctl within your github actions:

```yaml
Expand All @@ -111,7 +117,7 @@ jobs:
- name: Use Endorctl
run: |
endoctl api list -r Project
endorctl api list -r Project
```

## Supported Configuration Parameters
Expand Down

0 comments on commit e4ee275

Please sign in to comment.