Skip to content

doc: Add llms.txt for the 🤖 🕷️ #534

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

Merged
merged 1 commit into from
Sep 16, 2025
Merged

doc: Add llms.txt for the 🤖 🕷️ #534

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
55 changes: 55 additions & 0 deletions llms.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# SBOM Action

GitHub Action for creating software bill of materials (SBOM) using Syft.

## Project Overview

This is Anchore's official GitHub Action that generates Software Bill of Materials (SBOMs) using the Syft scanner. The action can scan container images, directories, and files to produce SBOMs in various formats including SPDX and CycloneDX.

## Key Features

- Generate SBOMs from container images, directories, or files
- Support for multiple SBOM formats (SPDX, CycloneDX)
- Automatic upload to GitHub releases as assets
- Integration with GitHub's dependency submission API
- Support for private container registries with authentication

## Architecture

The action is built with TypeScript and consists of several main components:

- `src/runSyftAction.ts` - Main entry point for SBOM generation
- `src/Syft.ts` - Syft tool wrapper and configuration
- `src/github/` - GitHub API integration for uploads and releases
- `src/downloadSyft.ts` - Handles downloading the Syft binary
- `src/attachReleaseAssets.ts` - Manages release asset uploads

## Usage

Basic usage:
```yaml
- uses: anchore/sbom-action@v0
```

Scan container image:
```yaml
- uses: anchore/sbom-action@v0
with:
image: ghcr.io/example/image_name:tag
```

## Development

- Built with TypeScript and Node.js (v20.11.0+)
- Uses GitHub Actions SDK (@actions/core, @actions/github)
- Testing with Jest
- Linting with ESLint and formatting with Prettier
- Automated builds with ncc for distribution

## Repository Structure

- `/src/` - TypeScript source code
- `/dist/` - Compiled JavaScript for distribution
- `/tests/` - Test files and fixtures
- `/download-syft/`, `/publish-sbom/` - Sub-actions
- `action.yml` - Main action configuration
Loading