CI/CD: a branch without a review namespace now shows orange, not red
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 78/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- github-actions, kubernetes
- Domain
- devops, documentation
Research direction
Start with content/6.deployment/3.ci-cd.md and inspect the k8s.sh function table, using components-web-app commit 5b6a953 as the behavior reference. Update the Review Apps and function documentation, and check whether a GitHub Actions page needs the warning annotation and skipped steps. Done means the orange-versus-red behavior, namespace creation, unchanged staging/production behavior, and listed functions are accurately documented.
Written by the indexing model from the issue text.
Description
components-web-app 5b6a953 changes what the review job does on a branch that has no namespace. content/6.deployment/3.ci-cd.md needs updating.
What changed
- Before:
ensure_namespacefailed and the pipeline went red on every branch nobody had provisioned a namespace for, which was nearly all of them. A red pipeline said nothing, and a real deploy failure looked the same. - Now: the review job runs
skip_review_without_namespacefirst.- When the namespace is missing (the API returns NotFound or Forbidden), it exits 3, and the job's
allow_failure: exit_codes: [3]shows the pipeline orange ("passed with warnings"). - A deploy that really fails, and any other
kubectlerror (an unreachable cluster, a bad context), is still red.
- When the namespace is missing (the API returns NotFound or Forbidden), it exits 3, and the job's
- Staging, canary and production are unchanged: a missing namespace there still fails hard.
- GitHub Actions has no orange state. The review job adds a warning annotation and skips its deploy, fixtures and warm steps.
Pages
- Review Apps section: "Every branch (except
main) gets its own Kubernetes namespace" isn't accurate. A branch gets a review environment only once someone creates its namespace, with role bindings. Say what orange means, and how to create a namespace for a branch that needs one. - The
k8s.shfunction table: addskip_review_without_namespaceandreview_namespace_state, and note thatensure_namespaceis still what staging and production use. - GitHub Actions page, if there is one: the warning annotation and the skipped steps.
- Dominant language
- Vue
- Stars
- 0
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from components-web-app/docs
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
components-web-app/docs#119 ·
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
components-web-app/docs#1 · 2 comments ·
All issues in components-web-app/docs
Similar issues
-
area: tests perceived difficulty: 2
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Nitjsefnie-Harness-Commons/daedalus#1255 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
siderolabs/terraform-provider-talos#414 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Maintainers usually reply within 1 day
-
agent/quality hive/hosted-available-lke648397-260827-5n31 quality testing
Difficulty 2/5 1-3 hours Newbie friendliness 91/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
scaleway/helm-charts#61 ·