---
# System prepended metadata

title: Improvement notes

---

# Improvement notes

Notes to keep track of potential improvements for v1.4.0 release cycle!


## Open issues for improvements:

All items below are also tracked in https://github.com/kubernetes-sigs/cluster-api/issues/7524

- [ ] cc release team on image promotion PRs: [open PR](https://github.com/kubernetes-sigs/cluster-api/pull/7487) **(@ykakarap/alexander)**
  
  **Update (7.02.2023):** it is not possible to cc release team github handle since it is in k8s-sigs github org whereas PRs are targeted to k/k repo.


---

- [ ] cc release team on cherry-pick PRs **(nawaz)**
    * Best way to do it, is probably by extending the cherrypicker in test-infra
    * Alternative or temporary solution could be a GitHub action in the cluster-api repo

    **Update (7.02.2023):** WIP


---

- [ ] Theoretically we can use k8s-triage to generate bug reports for flaky tests via "file bug" (link). Unfortunately the issues are always filed against k/k so we have to manually copy&paste the issue text to a Cluster API repo. Let's see if we can improve k8s-triage to be able to create issues in the Cluster API repo. **(aniruddha)**


---

- [ ] Automate release branch and tag creation: [tracking open issue](https://github.com/kubernetes-sigs/cluster-api/issues/7128) **(@ykakarap)**
**Main idea here:** is to use some automation (i.e [krel](https://github.com/kubernetes/release/tree/master/docs/krel) to automate release branch and tag creation). The workflow could be something like: someone opens a pr with changelog notes placed in specific folder, it gets proper labels approve/lgtm from the maintaiers, and once it is merged, GA takes an action and creates a tag for the release, and puts content from the merged pr to the draft release notes.


---

- [ ] Consider implementing a tool to generate our ProwJob YAMLs to make the jobs easier to manage **(@sbueringer)**

    * also check if there is already something like that


---

- [ ] Produce SBoM: [tracking open issue](https://github.com/kubernetes-sigs/cluster-api/issues/6153) **(furkat)**

    **Update (7.02.2023):** WIP


---

- [ ] Improve the Homebrew publish process: [tracking open issue](https://github.com/kubernetes-sigs/cluster-api/issues/6613) **(alexander)**

    **Update (7.02.2023):** Upstream homebrew had a fix for the issue and it can be closed.
**Update (22.02.2023, Furkat):** I had some discussions around this topic with homebrew maintainers, TL;DR is in this [comment](https://github.com/kubernetes-sigs/cluster-api/issues/6613#issuecomment-1440034230).
---

- [ ] ~~Discovering the ways to automate bug triaging in the CAPI repo (furkat)~~**
    *  ~~Main idea here is sync all open issues from the CAPI repository under a current release milestone (i.e v1.4.0) to a Bug Triage GitHub Project board (similar to https://github.com/orgs/kubernetes/projects/80~~)
    *  ~~For that, upstream k/k release team folks make use of a [script](https://github.com/kubernetes/sig-release/pull/1969) in a local fork where the script is [run](https://github.com/hosseinsalahi/sig-release/blob/bug-triage-gh-actions/.github/workflows/bugtriage.yml) from a GitHub Action daily~~

**Update:** Good to have but it might not be worth the effort at least for this release cycle, considering the volume of issues/PRs to be tracked is relatively low.


---

- [x] Discuss with community and the maintainers about the possibility of dropping old release jobs from the testgrid **(furkat)**:
    - https://testgrid.k8s.io/sig-cluster-lifecycle-cluster-api-0.3
    - https://testgrid.k8s.io/sig-cluster-lifecycle-cluster-api-0.4
    - https://testgrid.k8s.io/sig-cluster-lifecycle-cluster-api-1.0
    - https://testgrid.k8s.io/sig-cluster-lifecycle-cluster-api-1.1

    **Update (7.02.2023):** [started](https://github.com/kubernetes-sigs/cluster-api/issues/7811#issuecomment-1375820196) the discussion with the maintainers about how it should be handled and best practices around it. 
    - [x] Tracking issue: https://github.com/kubernetes-sigs/cluster-api/issues/8039
    
    **Update (22.02.2023):** 
    - [x] PR to remove the jobs: https://github.com/kubernetes/test-infra/pull/28808



---

- [x] Add failing/flaking test Github issue templates to the repo **(furkat)**:
    - [x] Initial PR to add the templates: [7778](https://github.com/kubernetes-sigs/cluster-api/pull/7778)
    - [x] Followup to above, move all issue templates to GitHub forms: [7819](https://github.com/kubernetes-sigs/cluster-api/pull/7819)
