Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add release method #41

Merged
merged 1 commit into from
Feb 13, 2025
Merged

docs: add release method #41

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 15 additions & 6 deletions docs/examples.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,20 +39,29 @@ Now let's dive into various use cases and examples.

```bash
sbommv transfer --input-adapter=github --in-github-url="https://github.com/sigstore/cosign" \
--output-adapter=interlynk --out-interlynk-url="https://api.interlynk.io/lynkapi"
--in-github-method=release --output-adapter=interlynk --out-interlynk-url="https://api.interlynk.io/lynkapi" --dry-run
```

- **What this does**:
- Fetches SBOMs from the latest release of the repository sigstore/cosign
- Uploads them to Interlynk
- And prints the feched SBOMs as well as SBOMs to be uploaded on Interlynk

- **NOTE**:
- `dry-run` method display the preview of the SBOMs to be uploaded, project to be created on Interlynk.
- remove the `dry-run` flag, to process with uploading part.

```bash
sbommv transfer --input-adapter=github --in-github-url="https://github.com/sigstore/cosign" \
--in-github-method=release --output-adapter=interlynk --out-interlynk-url="https://api.interlynk.io/lynkapi"
```

### 1.2 GitHub API Method (Dependency Graph)
### 1.2 GitHub API Method (Dependency Graph): default method

#### Fetch SBOMs using the GitHub API and upload to Interlynk

```bash
sbommv transfer --input-adapter=github --in-github-url="https://github.com/sigstore/cosign" \
--in-github-method=api --output-adapter=interlynk --out-interlynk-url="https://api.interlynk.io/lynkapi"
--output-adapter=interlynk --out-interlynk-url="https://api.interlynk.io/lynkapi"
```

- **What this does**:
Expand Down Expand Up @@ -152,7 +161,7 @@ sbommv transfer --input-adapter=github --in-github-url="https://github.com/sigst

```bash
sbommv transfer --input-adapter=github --in-github-url="https://github.com/sigstore" \
--in-github-method=api --in-github-include-repos=cosign,rekor \
--in-github-include-repos=cosign,rekor \
--output-adapter=interlynk --out-interlynk-url="https://api.interlynk.io/lynkapi"
```

Expand All @@ -166,7 +175,7 @@ sbommv transfer --input-adapter=github --in-github-url="https://github.com/sigst

```bash
sbommv transfer --input-adapter=github --in-github-url="https://github.com/sigstore" \
--in-github-method=api --in-github-exclude-repos=docs \
--in-github-exclude-repos=docs \
--output-adapter=interlynk --out-interlynk-url="https://api.interlynk.io/lynkapi"
```

Expand Down