CI/CD: image variants and the cache warm now run in one GitLab job
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 62/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- gitlab, shell
- Domain
- ci-cd, documentation
Research direction
Read the image_variants_and_warm function in bin/devops/k8s.sh and the GitLab job description in the issue to confirm the combined job name. Then update content/6.deployment/3.ci-cd.md at lines 246 and 268, replacing the separate variants and warm job names with the combined image variants and warm <track> job. Check the wording at content/6.deployment/4.variables.md line 376. Done when the three pages describe one job per track; the release link waits until the template is released.
Written by the indexing model from the issue text.
Description
From components-web-app/components-web-app#160 (commit 5f987be09ccf7ecfda261be61662020f7d72ea67, in the template's Unreleased section, so the next release after 2.0.0-alpha.30).
On GitLab, the image variants <track> and warm cache <track> jobs are now one job per track, image variants and warm <track> (the image_variants_and_warm function in bin/devops/k8s.sh). A separate warm job waited about 50 s for a runner after every deploy.
- It runs the variants first and then the warm, in the same order as before (the warm must never come first, #153).
- Each half keeps its switch:
CWA_CI_IMAGE_VARIANTS_*andCWA_CI_WARM_CACHE_*, with production on unless"false"and the other tracks off unless"true". The job runs when either is on. - If one half fails, the other still runs. Either failure fails the job, which is
allow_failure, so a live deploy is never marked failed. - The
performance audit <track>jobs nowneeds:the combined job. - GitHub is unchanged: its steps already run one after another in the same job.
Pages to update:
content/6.deployment/3.ci-cd.md:246: listsimage variants review/staging/canary/productionas their own jobs.content/6.deployment/3.ci-cd.md:268: says the warm runs "as its own job" and lists thewarm cache <track>jobs.- Check
content/6.deployment/4.variables.md:376(CWA_CI_PRODUCTION_DISABLEDremoves "image variants, cache warm … jobs"); the wording can stay, but there's now one job for both. - Add the release link once the template version is released.
Upgrade note for downstream projects: copy .gitlab-ci.yml and bin/devops/k8s.sh. A project job that needs: either old job name must use the new name.
- 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
-
Document opening the add page data form with defaults (?parentPage, ?parentPageData, ?template)Opendocumentation
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
components-web-app/docs#230 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
components-web-app/docs#227 ·
-
Difficulty 3/5 Half a day Newbie friendliness 58/100
components-web-app/docs#229 ·
-
documentation
Difficulty 3/5 1-3 hours Newbie friendliness 25/100
components-web-app/docs#226 ·
-
Website copy: inaccurate infrastructure claims, typos, a broken link and commented-out leftoversOpenenhancement
Difficulty 3/5 1-2 days Newbie friendliness 62/100
components-web-app/docs#175 ·
All issues in components-web-app/docs
Similar issues
-
`automountServiceAccountToken` is in the wrong section of `plugin-site-issue` deployment templateOpenbug plugin-site-issues
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
jenkins-infra/helm-charts#2074 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
Maintainers usually reply within 1 day
-
helm: Service template renders invalid externalTrafficPolicy: "" for NodePort/LoadBalancerPossibly taken A pull request linked to this issue is open or already merged. Open
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
kubernetes-sigs/headlamp#7950 ·
Maintainers usually reply within 3 days
-
v3.8.0 vanilla manifest points to non-existent images registry.k8s.io/csi-vsphere/csi-vsphere/{driver,syncer}Possibly taken A pull request linked to this issue is open or already merged. Openkind/bug
Difficulty 1/5 1-3 hours Newbie friendliness 85/100
kubernetes-sigs/vsphere-csi-driver#4351 ·
Maintainers usually reply within 1 day
-
component/gpu-kubelet-plugin component/helm needs-triage
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
kubernetes-sigs/dra-driver-nvidia-gpu#1559 ·
Maintainers usually reply within 1 day