pulp / pulp/pulp-ui

Proposal: Overhaul PulpUI Github Actions to a hardened, per job-concern model.

Open
#362 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
29
Forks
22
Avg merge
2d 6h
Merged PRs (30d)
19

Description

Summary

The current Continuous Integration (CI) implementation against main runs a set of checks against every pull request, but lacks the newer security posture needed in areas such as static analysis, dependency review and pipeline documentation. As development on pulp-ui accelerates and new features sets land, the pipeline needs to grow to match both to cover new security requirements and provide clear, consistent gateway for code to pass through.

This proposes a full restructure, not an incremental patch, to a job-per-concern reusable-workflow model. Every addition will be mapped explicitly to either OWASP or an existing internal Pulp governance.

High Level Design

Image

Implementations

Continuous checks - pr.yml / main.yml / schedule.yml
  • linting: Handles all linting using application tooling via eslint, prettier and tsc.
  • workflow-lint: Lints the CI workflows and raises issues.
  • tests: Existing test command, unchanged.
  • build: Existing build command, unchanged.
  • sast-quality: Conducts static analysis across the application code using codeql.
  • secrets-scaning: Uses gitleaks as per Pulp governance.
  • dependency-review: Checks newly added packages against current.
  • sca: Conducts full scan of dependency tree.
Release-gated checks - release.yml
  • build: Existing build command, unchanged.build: Existing build command, unchanged.
  • provenance: Generates SBOM then using ephemeral keys, attests against the build.

Out of Scope

  1. Logging and Visibility - requires administrative permissions to conduct an audit on current logging and retention on GitHub actions within this repository to suggest a course of action (COA).

  2. Changes to branching strategy - future branching iterations for feature release will be out of scope.

References

  1. https://docs.github.com/en/actions/reference/security/secure-use
  2. https://owasp.github.io/www-project-top-10-ci-cd-security-risks/
  3. https://github.com/Redtigercod4/pulp-ui/tree/next/.github/workflows

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing workflows under .github/workflows, especially pr.yml, main.yml, schedule.yml, and release.yml, then compare them with the secure-use and OWASP references. The work is done when the workflows follow the proposed per-concern structure, include the listed linting, analysis, scanning, dependency, and release checks, and document their roles.

Written by the indexing model from the issue text.

Assessment

Tech stack
eslint, github-actions, typescript
Domain
build-system, ci-cd, security
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.