{"id":49441980,"url":"https://github.com/scality/sbom-upload","last_synced_at":"2026-04-29T20:37:33.291Z","repository":{"id":327405936,"uuid":"1054252578","full_name":"scality/sbom-upload","owner":"scality","description":"Upload SOM to Dependenccy Track","archived":false,"fork":false,"pushed_at":"2025-12-03T15:12:38.000Z","size":470,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-12-06T16:38:00.751Z","etag":null,"topics":["dependency-track","github-actions","python","sbom","security"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/scality.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.MD","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-09-10T15:18:06.000Z","updated_at":"2025-12-03T15:11:48.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/scality/sbom-upload","commit_stats":null,"previous_names":["scality/sbom-upload"],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/scality/sbom-upload","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scality%2Fsbom-upload","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scality%2Fsbom-upload/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scality%2Fsbom-upload/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scality%2Fsbom-upload/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/scality","download_url":"https://codeload.github.com/scality/sbom-upload/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scality%2Fsbom-upload/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32443568,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-29T20:22:27.477Z","status":"ssl_error","status_checked_at":"2026-04-29T20:22:26.507Z","response_time":110,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dependency-track","github-actions","python","sbom","security"],"created_at":"2026-04-29T20:37:31.387Z","updated_at":"2026-04-29T20:37:33.279Z","avatar_url":"https://github.com/scality.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SBOM Upload Action\n\n[![GitHub release](https://img.shields.io/github/release/scality/sbom-upload.svg)](https://github.com/scality/sbom-upload/releases/latest)\n[![License: Apache-2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/scality/sbom/blob/main/LICENSE)\n\nA GitHub Action and CLI tool for uploading Software Bill of Materials (SBOM) files to [Dependency Track](https://dependencytrack.org/).\n\n## ✨ Features\n\n- 🚀 **GitHub Action Integration** - Seamless CI/CD pipeline integration\n- 📁 **Multiple Upload Methods** - Single SBOMs, batch uploads, or custom hierarchies  \n- 🏗️ **Hierarchical Projects** - Create parent/child project relationships\n- 🎨 **Auto Hierarchy Generation** - Generate 3-level hierarchies from nested SBOM structures\n- 🔄 **Version Management** - Semantic version comparison and latest detection\n- 🧪 **Local Testing** - CLI for development and debugging\n- 🎯 **Auto-Detection** - Extract project info from SBOM metadata\n- 🔐 **Secure** - API key authentication with proper error handling\n- 🆔 **Unique Naming** - UUID suffixes prevent project name conflicts\n\n## 🚀 Quick Start\n\n### GitHub Action (Recommended)\n\n```yaml\nname: Upload SBOM\non: [push]\n\njobs:\n  upload:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v4\n      - uses: scality/sbom-upload@v1\n        with:\n          url: 'https://dependency-track.example.com'\n          api-key: ${{ secrets.DEPENDENCY_TRACK_API_KEY }}\n          project-sbom: 'sbom.json'\n```\n\n### CLI Usage\n\n```bash\n# Set environment variables\nexport INPUT_URL=\"https://dependency-track.example.com\"\nexport INPUT_API_KEY=\"your-api-key\"\n\n# Test connection\nPYTHONPATH=src python src/main.py test-connection\n\n# Upload single SBOM file\nexport INPUT_PROJECT_SBOM=\"sbom.json\"\nPYTHONPATH=src python src/main.py upload\n\n# Upload SBOM with custom project details (via environment)\nexport INPUT_PROJECT_SBOM=\"sbom.json\"\nexport INPUT_PROJECT_NAME=\"my-app\" \nexport INPUT_PROJECT_VERSION=\"1.0.0\"\nPYTHONPATH=src python src/main.py upload\n```\n\n## 📖 Documentation\n\n- **[Quick Start Guide](docs/QUICKSTART.md)** - Get started in minutes\n- **[Usage Examples](docs/USAGE_EXAMPLES.md)** - Comprehensive examples for GitHub Actions and CLI\n- **[Hierarchy Configuration](docs/HIERARCHY_CONFIG.md)** - Advanced project structures\n- **[CLI Reference](docs/CLI.md)** - Complete command-line interface documentation\n\n## 🛠️ Installation\n\n### For GitHub Actions\nNo installation required - just reference the action in your workflow.\n\n### For CLI Development\n```bash\ngit clone https://github.com/scality/sbom-upload.git\ncd sbom-upload\npip install -r requirements.txt\n```\n\n## 🎯 Use Cases\n\n- **CI/CD Integration** - Automatically upload SBOMs on builds/releases\n- **Multi-Service Applications** - Manage complex project hierarchies\n- **Security Compliance** - Track dependencies across your organization\n- **Version Management** - Maintain accurate version histories\n- **Development Workflows** - Test uploads locally before deployment\n\n## 📊 Supported Scenarios\n\n| Scenario | GitHub Action | CLI | Documentation |\n|----------|:-------------:|:---:|:-------------:|\n| Single SBOM Upload | ✅ | ✅ | [Examples](docs/USAGE_EXAMPLES.md#basic-single-sbom-upload) |\n| Multiple SBOMs | ✅ | ✅ | [Examples](docs/USAGE_EXAMPLES.md#multiple-sboms-from-file-list) |\n| Nested Projects | ✅ | ✅ | [Examples](docs/USAGE_EXAMPLES.md#advanced-configuration-with-custom-hierarchy) |\n| Auto Hierarchy Generation | ✅ | ✅ | [Usage Examples](docs/USAGE_EXAMPLES.md#hierarchy-generation-from-nested-sbom-structure) |\n| Custom Hierarchies | ❌ | ✅ | [Hierarchy Config](docs/HIERARCHY_CONFIG.md) |\n| Version Detection | ✅ | ✅ | [Usage Examples](docs/USAGE_EXAMPLES.md#with-version-detection) |\n| Dry Run Testing | ❌ | ✅ | [CLI Reference](docs/CLI.md) |\n\n## 🔧 Configuration\n\n### GitHub Action Inputs\n\n| Input | Required | Description | Example |\n|-------|:--------:|-------------|---------|\n| `url` | ✅ | Dependency Track server URL | `https://dt.example.com` |\n| `api-key` | ✅ | API key for authentication | `${{ secrets.DT_API_KEY }}` |\n| `project-sbom` | ✅* | Path to single SBOM file | `dist/sbom.json` |\n| `project-sbom-list` | ✅* | Path to file with SBOM list | `sbom-files.txt` |\n| `project-sbom-dir` | ✅* | Directory containing SBOMs | `dist/sboms/` |\n| `project-name` | ❌ | Override project name | `my-application` |\n| `project-version` | ❌ | Override project version | `1.2.3` |\n| `parent-project-name` | ❌ | Parent project name | `main-app` |\n| `parent-project-version` | ❌ | Parent project version | `2.0.0` |\n| `project-classifier` | ❌ | Project type classifier | `APPLICATION` |\n| `parent-project-classifier` | ❌ | Parent project classifier | `APPLICATION` |\n| `project-collection-logic` | ❌ | Collection logic for children | `AGGREGATE_DIRECT_CHILDREN` |\n| `parent-project-collection-logic` | ❌ | Parent collection logic | `AGGREGATE_DIRECT_CHILDREN` |\n| `is-latest` | ❌ | Mark as latest version | `true` |\n| `auto-detect-latest` | ❌ | Auto-detect latest flag | `true` |\n| `api-timeout` | ❌ | API timeout (seconds) | `300` |\n| `dry-run` | ❌ | Validate without uploading | `true` |\n| `project-prefix` | ❌ | Prefix for project names | `ci-` |\n| `project-suffix` | ❌ | Suffix for project names | `-prod` |\n| `project-tags` | ❌ | Comma-separated tags | `production,ci-cd` |\n| `delete-on-version-suffix-match` | ❌ | Delete existing leaf project when version matches suffix pattern (default `false`) | `true` |\n| `delete-version-suffix-pattern` | ❌ | Case-insensitive regex evaluated against project version when delete is enabled (default `dev`) | `dev$` |\n\n*One of `project-sbom`, `project-sbom-list`, or `project-sbom-dir` is required.\n\n[View all inputs →](docs/USAGE_EXAMPLES.md#environment-variables)\n\n## 🧪 Local Development\n\n```bash\n# Start local Dependency Track instance\ncd tests\ndocker-compose up -d\n\n# Test connection\nPYTHONPATH=src python src/main.py test-connection\n\n# Upload test SBOM\nexport INPUT_PROJECT_SBOM=\"tests/single_sbom/nginx_12.9.1.json\"\nexport INPUT_DRY_RUN=\"true\"\nPYTHONPATH=src python src/main.py upload\n```\n\n## 🤝 Contributing\n\n1. Fork the repository\n2. Create a feature branch (`git checkout -b feature/amazing-feature`)\n3. Commit your changes (`git commit -m 'Add amazing feature'`)\n4. Push to the branch (`git push origin feature/amazing-feature`)\n5. Open a Pull Request\n\n## 📄 License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## 🔗 Related Projects\n\n- [Dependency Track](https://dependencytrack.org/) - Software composition analysis platform\n- [CycloneDX](https://cyclonedx.org/) - SBOM standard specification\n- [SPDX](https://spdx.dev/) - Software package data exchange format\n\n## 📞 Support\n\n- 📚 [Documentation](docs/)\n- 🐛 [Issues](https://github.com/scality/sbom-upload/issues)\n- 💬 [Discussions](https://github.com/scality/sbom-upload/discussions)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscality%2Fsbom-upload","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscality%2Fsbom-upload","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscality%2Fsbom-upload/lists"}