[WIP] contrib & devel guide: pull in issue doc from sig-release/ephemera #2430

tpepper · 2018-07-27T20:36:41Z

The sig-release repo has a set of old documentation looking for a
better home. The issues.md document there describes how a developer
targets an issue (or PR) to a milestone release. This logically
fits better in the community/contributors/devel/ guide, so this commit
brings it in and a parallel commit will remove it from the other repo.

See also kubernetes/sig-release#240

Signed-off-by: Tim Pepper tpepper@vmware.com

tpepper · 2018-07-27T20:37:06Z

/cc @guineveresaenger @spiffxp @justaugustus

This document describes how the community targets issues and PRs to a milestone release. As such I think it fits best in the developer guide. A portion of the information on escalating issues relates to the release team, but is already covered in the release-team role handbooks and that escalation process is good to have visible to developers broadly so they understand that they're liable to be pinged by the release team for clarifying information. See also kubernetes/community#2430 Signed-off-by: Tim Pepper <tpepper@vmware.com>

tpepper · 2018-07-27T20:48:57Z

/assign @spiffxp

guineveresaenger

Couple of tweaks and a question. Thanks @tpepper!

guineveresaenger · 2018-07-31T05:49:03Z

contributors/devel/issues.md

+
+The SIG owner label defines the SIG to which the bot will escalate if the issue is not resolved
+or updated by the deadline.  If there are no updates after escalation, the
+issue may automatically removed from the milestone.


"automatically be removed"

guineveresaenger · 2018-07-31T05:50:09Z

contributors/devel/issues.md

+- `priority/important-soon`: Escalate to the issue owners and SIG owner; move out of milestone after several unsuccessful escalation attempts.
+  - not considered a release blocking issue
+  - would not require a patch release
+  - will automatically be moved out of the release milestone at code freeze


it appears the bot removes these out of the milestone after 4 days - should that be mentioned here?

guineveresaenger · 2018-07-31T05:53:21Z

contributors/devel/issues.md

+    ```
+    **Action required**: This issue must have the `status/approved-for-milestone` label applied
+    by a SIG maintainer.
+    ```


see comment above - milestone/needs approval has a really short turnaround (4 days?) before the issue gets kicked out of the milestone.

Two lines just above this it notes if required labels are not applied within 3 days, the bot will remove. But I think that's 4 unless I'm reading the wrong yaml config line.

found it...mungegithub/mungers/milestone-maintainer.go has RegisterOptions() has the set of default intervals.

guineveresaenger · 2018-07-31T05:57:32Z

contributors/devel/issues.md

+                              Escalate to SIG and contributor through all available channels.
+    kind/bug: Fixes a bug.
+    ```
+  - **If the approved label is not applied within 7 days of the `milestone/needs-approval` label being applied, the bot will move the issue out of the milestone and apply the `milestone/removed` label (unless the issue is critical-urgent).**


I believe it is only 4 days.

milestoneOptApprovalGracePeriod is 168*time.Hour or seven days. "The grace period to wait before removing a non-blocking issue/pr without sig approval from the active milestone."

guineveresaenger · 2018-07-31T05:58:57Z

contributors/devel/issues.md

+
+Some issues are filed in repos outside the [kubernetes repo].  The bot must also be run against these
+repos and follow the same pattern.  The release team can query issues across repos in the kubernetes org using
+a query like [this](https://github.com/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+milestone%3Av1.7+org%3Akubernetes+)


let's update sample link to a more recent version

tweaked to 1.12

guineveresaenger · 2018-07-31T05:59:24Z

contributors/devel/issues.md

+
+it must also include:
+
+- a link to the repo with a query for issues in the milestone. See [this](https://github.com/kubernetes/kubectl/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aopen%20milestone%3Av1.7) example.


use 1.11 or 1.12 as example

tweaked to 1.12

spiffxp · 2018-07-31T15:38:20Z

I'm pretty sure issues.md was pulled over into sig-release because it was very k/k-release-process-hygiene-specific. I would examine parity with with the issue triage role's handbook. And suggest a re-write to be agnostic to the release process first, if it's going to live here.

ie: outside of kubernetes release world, we require sig/foo for all issues, but people aren't restricted to just one of kind/bug kind/cleanup kind/feature

guineveresaenger · 2018-07-31T16:17:08Z

It does feel like it should be made very clear that this is a release process specific doc that mainly explains the release-team's actions for the curious.

As such, it should have "release" in the title somewhere.

tpepper · 2018-07-31T16:32:09Z

I feel like it's off in the corner in k/sig-release and is not just release-team actions. Release team observes the results of what all developers do. I read the doc as-is today as more focused on how a developer signals that an issue or PR is targeted to a release milestone, and once establishing it, how they keep it there in the face of a bot and release team who might remove it. I feel like only from "Escalation" section to the end is release-team specific.

tpepper · 2018-07-31T16:36:32Z

I'll try to do some scrubbing versus issue triage and features handbooks in k/sig-release, and link from the proposed k/community/contributors/devel/issues.md to more detailed info on the release process there.

The documentation on how a developer gets code into a milestone release is proposed to move in kubernetes/community#2430 and would require an associated update of the url the milestone munger uses as a reference in its information GitHub comments. Signed-off-by: Tim Pepper <tpepper@vmware.com>

This document describes how the community targets issues and PRs to a milestone release. As such I think it fits best in the developer guide. A portion of the information on escalating issues relates to the release team, but is already covered in the release-team role handbooks and that escalation process is good to have visible to developers broadly so they understand that they're liable to be pinged by the release team for clarifying information. See also kubernetes/community#2430 Signed-off-by: Tim Pepper <tpepper@vmware.com>

tpepper · 2018-07-31T17:54:20Z

Re: #2430 (comment) the title does say:

Targeting issues and PRs to release milestones

I see this as more than informational to the curious and that's why I'm proposing it for the developer guide. It's how developers get their work into milestones properly, with the release team and the bot and SIG leads helping on risk management and insuring the appropriate level of documentation and tests are also present.

The sig-release repo has a set of old documentation looking for a better home. The issues.md document there describes how a developer targets an issue (or PR) to a milestone release. This logically fits better in the community/contributors/devel/ guide, so this commit brings it in and a parallel commit will remove it from the other repo. Signed-off-by: Tim Pepper <tpepper@vmware.com>

k8s-ci-robot · 2018-07-31T17:56:57Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To fully approve this pull request, please assign additional approvers.
We suggest the following additional approver: spiffxp

If they are not already assigned, you can assign the PR to them by writing /assign @spiffxp in a comment when ready.

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

contributors/devel/OWNERS
contributors/guide/OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

tpepper · 2018-08-01T18:03:24Z

/hold

Assuming no milestone munger, this doc needs a lot of rework.

tpepper · 2018-08-20T22:58:49Z

Will replace differently based on base weeks' discussions in slack and release meetings.

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. area/contributor-guide Issues or PRs related to the contributor guide sig/contributor-experience Categorizes an issue or PR as relevant to SIG Contributor Experience. labels Jul 27, 2018

k8s-ci-robot requested review from grodrigues3 and idvoretskyi July 27, 2018 20:36

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jul 27, 2018

k8s-ci-robot requested review from guineveresaenger, justaugustus and spiffxp July 27, 2018 20:37

tpepper mentioned this pull request Jul 27, 2018

move ephemera/issues.md to community repo devel guide kubernetes/sig-release#240

Merged

k8s-ci-robot assigned spiffxp Jul 27, 2018

guineveresaenger suggested changes Jul 31, 2018

View reviewed changes

tpepper mentioned this pull request Jul 31, 2018

milestone issue information moving kubernetes/test-infra#8902

Closed

tpepper force-pushed the master branch from 6ec52b2 to 9eb778c Compare July 31, 2018 17:56

tpepper mentioned this pull request Jul 31, 2018

Cherrypicks #2408

Merged

tpepper changed the title ~~contrib & devel guide: pull in issue doc from sig-release/ephemera~~ [WIP] contrib & devel guide: pull in issue doc from sig-release/ephemera Aug 1, 2018

k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 1, 2018

k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Aug 1, 2018

spiffxp mentioned this pull request Aug 13, 2018

Add notes on Milestone Maintainers kubernetes/sig-release#239

Merged

tpepper closed this Aug 20, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WIP] contrib & devel guide: pull in issue doc from sig-release/ephemera #2430

[WIP] contrib & devel guide: pull in issue doc from sig-release/ephemera #2430

tpepper commented Jul 27, 2018 •

edited

Loading

tpepper commented Jul 27, 2018

tpepper commented Jul 27, 2018

guineveresaenger left a comment

guineveresaenger Jul 31, 2018

tpepper Jul 31, 2018

guineveresaenger Jul 31, 2018

tpepper Jul 31, 2018

guineveresaenger Jul 31, 2018

tpepper Jul 31, 2018

tpepper Jul 31, 2018

guineveresaenger Jul 31, 2018

tpepper Jul 31, 2018

guineveresaenger Jul 31, 2018

tpepper Jul 31, 2018

guineveresaenger Jul 31, 2018

tpepper Jul 31, 2018

spiffxp commented Jul 31, 2018

guineveresaenger commented Jul 31, 2018

tpepper commented Jul 31, 2018

tpepper commented Jul 31, 2018

tpepper commented Jul 31, 2018

k8s-ci-robot commented Jul 31, 2018

tpepper commented Aug 1, 2018

tpepper commented Aug 20, 2018


		it must also include:

		- a link to the repo with a query for issues in the milestone. See [this](https://github.com/kubernetes/kubectl/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aopen%20milestone%3Av1.7) example.

[WIP] contrib & devel guide: pull in issue doc from sig-release/ephemera #2430

[WIP] contrib & devel guide: pull in issue doc from sig-release/ephemera #2430

Conversation

tpepper commented Jul 27, 2018 • edited Loading

tpepper commented Jul 27, 2018

tpepper commented Jul 27, 2018

guineveresaenger left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

spiffxp commented Jul 31, 2018

guineveresaenger commented Jul 31, 2018

tpepper commented Jul 31, 2018

tpepper commented Jul 31, 2018

tpepper commented Jul 31, 2018

Targeting issues and PRs to release milestones

k8s-ci-robot commented Jul 31, 2018

tpepper commented Aug 1, 2018

tpepper commented Aug 20, 2018

tpepper commented Jul 27, 2018 •

edited

Loading