Merge pull request #7576 from liggitt/api-project
Update API review project links
This commit is contained in:
commit
bad837c5e7
|
@ -125,7 +125,7 @@ Establishing and documenting conventions for system and user-facing APIs, define
|
|||
* [API Review process](https://github.com/kubernetes/community/blob/master/sig-architecture/api-review-process.md)
|
||||
* [Deprecation policy](https://kubernetes.io/docs/reference/deprecation-policy/)
|
||||
|
||||
Please see the [API Reviews](https://github.com/orgs/kubernetes/projects/13) tracking board to follow the work of this sub-project. Please reach out to folks in the [OWNERS](https://git.k8s.io/design-proposals-archive/architecture/OWNERS) file if you are interested in joining this effort.
|
||||
Please see the [API Reviews](https://github.com/orgs/kubernetes/projects/169) tracking board to follow the work of this sub-project. Please reach out to folks in the [OWNERS](https://git.k8s.io/design-proposals-archive/architecture/OWNERS) file if you are interested in joining this effort.
|
||||
|
||||
## Enhancement Proposals
|
||||
|
||||
|
|
|
@ -51,7 +51,7 @@
|
|||
|
||||
- For the enhancements subproject, all owners are all active.
|
||||
|
||||
- For the API review subproject, there are no standing meetings. The subproject coordinates via a [project board](https://github.com/orgs/kubernetes/projects/13) and [mailing list](https://groups.google.com/g/kubernetes-api-reviewers).
|
||||
- For the API review subproject, there are no standing meetings. The subproject coordinates via a [project board](https://github.com/orgs/kubernetes/projects/169) and [mailing list](https://groups.google.com/g/kubernetes-api-reviewers).
|
||||
|
||||
- For the code organization subproject, @dims and @liggitt run regular meetings and review PRs and issues, pulling in other owners as needed.
|
||||
|
||||
|
|
|
@ -153,7 +153,7 @@ Continuing:
|
|||
- API guidance updates
|
||||
- [Object references](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#object-references), including cross-namespace references from namespaced objects
|
||||
- [Spec and Status](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status) ([#5842](https://github.com/kubernetes/community/pull/5842))
|
||||
- 114 [API reviews completed](https://github.com/orgs/kubernetes/projects/13) in 2021 (30 for v1.21, 45 for v1.22, 39 for v1.23)
|
||||
- 114 [API reviews completed](https://github.com/orgs/kubernetes/projects/169) in 2021 (30 for v1.21, 45 for v1.22, 39 for v1.23)
|
||||
- Each SIG can identify 2-3 people to be involved in API reviews - https://github.com/kubernetes/kubernetes/blob/v1.23.0/OWNERS_ALIASES#L451-L452
|
||||
- [Conformance Definition](https://github.com/kubernetes/community/tree/master/sig-architecture#conformance-definition-1)
|
||||
- We started 2021 with 128 endpoints remaining without conformance test.(69.13% conformance tested)
|
||||
|
|
|
@ -78,14 +78,14 @@ Voluntary reviews apply towards non-core APIs that do not meet the [mandatory](#
|
|||
1. Request an API review for a PR or issue in the kubernetes org by adding the `api-review` label with a `/label api-review` comment (requests can be cancelled with a `/remove-label api-review` comment)
|
||||
* If this is a review of a PR implementing an already-reviewed design/KEP, reference the approved KEP and note any differences between the approved design and the implementation.
|
||||
|
||||
2. API reviews are tracked in a project board at https://github.com/orgs/kubernetes/projects/13
|
||||
2. API reviews are tracked in a project board at https://github.com/orgs/kubernetes/projects/169
|
||||
* Github query for requested reviews not yet in the project:
|
||||
* [`is:open org:kubernetes label:api-review -project:kubernetes/13`](https://github.com/search?q=is%3Aopen+org%3Akubernetes+label%3Aapi-review+-project%3Akubernetes%2F13)
|
||||
* [`is:open org:kubernetes label:api-review -project:kubernetes/169`](https://github.com/search?q=is%3Aopen+org%3Akubernetes+label%3Aapi-review+-project%3Akubernetes%2F169)
|
||||
* Github query for items in the project no longer requesting review:
|
||||
* [`is:open org:kubernetes -label:api-review project:kubernetes/13`](https://github.com/search?q=is%3Aopen+org%3Akubernetes+-label%3Aapi-review+project%3Akubernetes%2F13)
|
||||
* [`is:open org:kubernetes -label:api-review project:kubernetes/169`](https://github.com/search?q=is%3Aopen+org%3Akubernetes+-label%3Aapi-review+project%3Akubernetes%2F169)
|
||||
* Requests are triaged by API approvers/reviewers/moderators [regularly](#review-lifecycle-timing), and added to the project board if prereqs have been completed
|
||||
* As requests are added to the project board, that is reflected in the sidebar of the issue or PR, along with the current status (backlog, assigned, in progress, completed)
|
||||
* The API review backlog and queue is publicly visible at https://github.com/orgs/kubernetes/projects/13
|
||||
* The API review backlog and queue is publicly visible at https://github.com/orgs/kubernetes/projects/169
|
||||
|
||||
3. Backlog
|
||||
* An approver or moderator will adjust the prioritization of the issue in the backlog. Reviews are prioritized based on a number of factors:
|
||||
|
@ -99,14 +99,14 @@ Voluntary reviews apply towards non-core APIs that do not meet the [mandatory](#
|
|||
* An approver or moderator will assign an approver (or potentially aspiring reviewer - see *training reviews* below for the aspiring reviewer workflow)
|
||||
* Reviews are assigned based on reviewer capacity and domain knowledge
|
||||
* Assignment of reviewers is done on the issue/PR itself using the normal `/assign` method (works seamlessly with existing github/PR dashboard queries)
|
||||
* All API reviews assigned to an individual can be viewed in the project board ([example](https://github.com/orgs/kubernetes/projects/13/?card_filter_query=assignee%3Aliggitt)), for visibility on status, order, and reviewer load
|
||||
* All API reviews assigned to an individual can be viewed in the project board ([example](https://github.com/orgs/kubernetes/projects/169/views/3?filterQuery=assignee%3Aliggitt)), for visibility on status, order, and reviewer load
|
||||
|
||||
5. In Progress / Approved / Changes Requested / Rejected
|
||||
* Reviews proceed like a normal KEP or PR review. Possible outcomes:
|
||||
* Approval:
|
||||
* Implementation PRs are tagged with `/lgtm /approve` and merged normally
|
||||
* KEP PRs containing API designs can also be tagged with `/lgtm /approve`, but should explicitly note if API approval is being given. This approval should be linked to when later requesting review of the implementation PR, and should limit the scope of the implementation review to differences between the approved design and final implementation, problems encountered during implementation, and correctness of the implementation.
|
||||
* The approved issue is archived in the review project board, and the `api-review` label is removed.
|
||||
* The approved issue is archived in the review project board.
|
||||
* Changes requested:
|
||||
* Comments or questions are left on the PR or issue, and the reviewer notifies the submitter
|
||||
* The reviewer moves the issue to "Changes Requested" in the review project board
|
||||
|
|
Loading…
Reference in New Issue