open-feature/js-sdk-contrib

Generate SBOMs for JS components

Open

#629 opened on Nov 1, 2023

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)TypeScript (80 forks)auto 404
contribfestgood first issuehelp wantedsecurity

Repository metrics

Stars
 (73 stars)
PR merge metrics
 (PR metrics pending)

Description

We have SBOMs currently for Java and Go contribs. We could use them here as well. I recommend this utility: https://github.com/marketplace/actions/cyclonedx-node-js-generate-sbom (we're using the clyclonedx format elsewhere and it's popular).

Definition of done:

  • SBOMs generated and attached to release artifact in GH, or otherwise made publicly available (for every release)
  • runtime dependencies only included
  • only includes dependencies of module in question (not of repo)

Relates to: https://github.com/open-feature/js-sdk/issues/649

Contributor guide

Research direction
Configure the CycloneDX Node.js Generate SBOM GitHub Action in the release workflow to generate an SBOM for JavaScript components, ensuring only runtime dependencies and the specific module are included, then attach the SBOM to the release artifact.
Tech stack
typescript
Domain
devopsbuild system
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitGitHub Actions
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65