From 7fbca08c024d57167e2f66c8c17f98a258f7b616 Mon Sep 17 00:00:00 2001 From: tomsweeneyredhat Date: Mon, 14 Apr 2025 16:11:48 -0400 Subject: [PATCH] [CI:DOCS] Add CNCF roadmap, touchup other CNCF files Added a ROADMAP.md file per CNCF requirements. Updated the GOVERNANCE.md file to point to and use the local MAINTAINERS.md file instead of the one in Podman. Also added links to the OWNERS file. Updated the MAINTAINERS.md file to bump Aditya Rajan to a Maintainer from a reviewer. Having him as a reviewer was a cut/paste error that was not caught when the file was first generated from the Podman file. Signed-off-by: tomsweeneyredhat --- GOVERNANCE.md | 11 ++++++++++- MAINTAINERS.md | 8 ++++++-- OWNERS | 1 + ROADMAP.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 65 insertions(+), 3 deletions(-) create mode 100644 ROADMAP.md diff --git a/GOVERNANCE.md b/GOVERNANCE.md index 3794542d7..94b838e39 100644 --- a/GOVERNANCE.md +++ b/GOVERNANCE.md @@ -1,3 +1,12 @@ ## The Buildah Project Community Governance -The Buildah project, as part of Podman Container Tools, follows the [Podman Project Governance](https://github.com/containers/podman/blob/main/GOVERNANCE.md). +The Buildah project, as part of Podman Container Tools, follows the [Podman Project Governance](https://github.com/containers/podman/blob/main/GOVERNANCE.md) +except sections found in this document, which override those found in Podman's Governance. + +--- + +# Maintainers File + +The definitive source of truth for maintainers of this repository is the local [MAINTAINERS.md](./MAINTAINERS.md) file. The [MAINTAINERS.md](https://github.com/containers/podman/blob/main/MAINTAINERS.md) file in the main Podman repository is used for project-spanning roles, including Core Maintainer and Community Manager. Some repositories in the project will also have a local [OWNERS](./OWNERS) file, which the CI system uses to map users to roles. Any changes to the [OWNERS](./OWNERS) file must make a corresponding change to the [MAINTAINERS.md](./MAINTAINERS.md) file to ensure that the file remains up to date. Most changes to [MAINTAINERS.md](./MAINTAINERS.md) will require a change to the repository’s [OWNERS](.OWNERS) file (e.g., adding a Reviewer), but some will not (e.g., promoting a Maintainer to a Core Maintainer, which comes with no additional CI-related privileges). + +Any Core Maintainers listed in Podman’s [MAINTAINERS.md](https://github.com/containers/podman/blob/main/MAINTAINERS.md) file should also be added to the list of “approvers” in the local [OWNERS](./OWNERS) file and as a Core Maintainer in the list of “Maintainers” in the local [MAINTAINERS.md](./MAINTAINERS.md) file. diff --git a/MAINTAINERS.md b/MAINTAINERS.md index 8ba451fda..a74b519df 100644 --- a/MAINTAINERS.md +++ b/MAINTAINERS.md @@ -1,6 +1,6 @@ # Buildah Maintainers -[GOVERNANCE.md](https://github.com/containers/podman/blob/main/GOVERNANCE.md) +[GOVERNANCE.md](GOVERNANCE.md) describes the project's governance and the Project Roles used below. ## Maintainers @@ -16,9 +16,9 @@ describes the project's governance and the Project Roles used below. | Neil Smith | [Neil-Smith](https://github.com/Neil-Smith) | Community Manager | [Red Hat](https://github.com/RedHatOfficial) | | Tom Sweeney | [TomSweeneyRedHat](https://github.com/TomSweeneyRedHat/) | Maintainer and Community Manager | [Red Hat](https://github.com/RedHatOfficial) | | Lokesh Mandvekar | [lsm5](https://github.com/lsm5) | Maintainer | [Red Hat](https://github.com/RedHatOfficial) | +| Aditya Rajan | [flouthoc](https://github.com/flouthoc) | Maintainer | [Red Hat](https://github.com/RedHatOfficial) | | Dan Walsh | [rhatdan](https://github.com/rhatdan) | Maintainer | [Red Hat](https://github.com/RedHatOfficial) | | Ashley Cui | [ashley-cui](https://github.com/ashley-cui) | Reviewer | [Red Hat](https://github.com/RedHatOfficial) | -| Aditya Rajan | [flouthoc](https://github.com/flouthoc) | Reviewer | [Red Hat](https://github.com/RedHatOfficial) | | Jan Rodák | [Honny1](https://github.com/Honny1) | Reviewer | [Red Hat](https://github.com/RedHatOfficial) | | Valentin Rothberg | [vrothberg](https://github.com/vrothberg) | Reviewer | [Red Hat](https://github.com/RedHatOfficial) | @@ -29,3 +29,7 @@ None at present ## Credits The structure of this document was based off of the equivalent one in the [CRI-O Project](https://github.com/cri-o/cri-o/blob/main/MAINTAINERS.md). + +## Note + +If there is a discrepancy between the [MAINTAINERS.md](https://github.com/containers/podman/blob/main/MAINTAINERS.md) file in the main Podman repository and this file regarding Core Maintainers or Community Managers, the file in the Podman Repository is considered the source of truth. diff --git a/OWNERS b/OWNERS index 3966ab9b5..4deab2960 100644 --- a/OWNERS +++ b/OWNERS @@ -1,5 +1,6 @@ approvers: - baude + - flouthoc - giuseppe - lsm5 - Luap99 diff --git a/ROADMAP.md b/ROADMAP.md new file mode 100644 index 000000000..ae67904df --- /dev/null +++ b/ROADMAP.md @@ -0,0 +1,48 @@ +![buildah logo (light)](logos/buildah-logo_large.png#gh-light-mode-only) +![buildah logo (dark)](logos/buildah-logo_reverse_large.png#gh-dark-mode-only) + +# Buildah Roadmap + +The Buildah development team reviews feature requests from its various stakeholders for consideration +quarterly along with the Podman Development team. These features are then prioritized and the top +features are then assigned to one or more engineers. + + +## Future feature considerations + +The following features are of general importantance to Buildah. While these features have no timeline +associated with them yet, they will likely be on future quarterly milestones. + +* Ongoing work around partial pull support (zstd:chunked) +* Improved support for the BuildKit API. +* Performance and stability improvements. +* Reductions to the size of the Buildah binary. + +## Milestones and commitments by quarter + +This section is a historical account of what features were prioritized by quarter. Results of the prioritization will be added at start of each quarter (Jan, Apr, July, Oct). + +### 2025 Q2 #### + +#### Releases #### +- [ ] Buildah 1.40 + +#### Features #### +- [ ] Reduce binary size of Buildah +- [ ] Additional Containerfile command options + +#### CNCF #### +- [ ] Add and adhere to Governance model +- [ ] Update Maintainers file + +### 2025 Q1 #### + +#### Releases #### +- [x] Buildah 1.39 + +#### Features #### +- [x] Artifact add --options + +#### CNCF #### +- [x] Create Governance documentation +- [x] Create Maintainers file