Kuadrant/kuadrant-console-plugin

docs: create CI.md to document e2e pipeline design and decisions

Open

#664 opened on Jul 17, 2026

View on GitHub
 (2 comments) (1 reaction) (1 assignee)TypeScript (63 forks)auto 404
documentationgood first issuetriage/accepted

Repository metrics

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

Description

Our CI pipeline has grown complex recently with the addition of smoke/nightly test split, changed-file inference suite router (two-list approach), and spec map coverage check. Suggested by @jasonmadigan in PR review.

What to document

  • General setup — how the e2e pipeline works end to end (oinc cluster, plugin dev server, Playwright)
  • Test tags — @smoke vs @nightly: what they mean, when to use each
  • Suite router — two-list design (specs vs test_specs), fallback behaviour, component mapping
  • Spec map check — what build/check-spec-map.sh does, how to run locally (yarn check:spec-map)
  • Design decisions — why two lists instead of one flag, why nightly runs on test file changes only
  • Adding new tests — checklist: tag, update suite-router mapping, run check:spec-map

Location

docs/ci.md — referenced from CLAUDE.md and AGENTS.md

Contributor guide

Research direction
Tech stack
Domain
Issue type
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Prerequisites
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.