Condense README sections #673

Bubblemelon · 2019-03-02T04:16:59Z

Related PR #671

k8s-ci-robot · 2019-03-02T04:17:06Z

Hi @Bubblemelon. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Bubblemelon

The one suggestion that I didn't apply to this change is adding the sentence about stage, release, announce. I believe this process is quite evident in the Branch Manager Handbook.

Bubblemelon · 2019-03-02T04:19:39Z

README.md

+[`branchff`](https://github.com/kubernetes/release/blob/master/branchff) | Fast-forward branching helper : <br/><br/> A tool used to pull new patches onto the release branch.
+<br/> [`find_green_build`](https://github.com/kubernetes/release/blob/master/find_green_build) <br/><br/> | Asks Jenkins for a good build to use.
+<br/> [`release-notes`](https://github.com/kubernetes/release/blob/master/cmd/release-notes) <br/><br/> | Scrape GitHub for release notes. See [Release Notes Gathering](#release-notes-gathering) for more information.
+<br/> [`prin`](https://github.com/kubernetes/release/blob/master/prin) <br/><br/> | What tags/releases is my PR IN?


I verbosely copied this over from the old README. Does this simply mean, "To show tags/releases that a PR is in." ?

Yes.

E.g. when I am in the directory of the k8s source and call the script with a random PR number or a random commit hash, it shows which tags those PR/commit is included in. However, I have never ever used that script before.

user@b3a1b221edab:/usr/local/google/branchff-release-1.12/src/k8s.io/kubernetes$ /src/prin '69500' Skipping security_layer::hosted_map extensions... COMMITS: 3f102c3980 (initial) (cherrypicks) (https://github.com/kubernetes/kubernetes/pull/69500) LATENCY TO APPEAR (DAYS) TAG K8S --- --- v1.13.0 49.22 v1.13.0-alpha.1 3.10 v1.13.0-alpha.2 11.62 v1.13.0-alpha.3 18.57 v1.13.0-beta.0 26.01 v1.13.0-beta.1 35.42 v1.13.0-beta.2 41.26 v1.13.0-rc.1 46.32 v1.13.0-rc.2 47.36 v1.13.1 60.78 v1.13.1-beta.0 52.10 v1.13.2 88.56 v1.13.2-beta.0 61.67 v1.13.3 111.97 v1.13.3-beta.0 90.21 v1.13.4 137.53 v1.13.4-beta.0 112.06 v1.13.5-beta.0 138.79 v1.14.0-alpha.0 25.94 v1.14.0-alpha.1 94.68 v1.14.0-alpha.2 108.62 v1.14.0-alpha.3 122.58 v1.14.0-beta.0 129.81 v1.14.0-beta.1 136.64 v1.15.0-alpha.0 129.77 user@b3a1b221edab:/usr/local/google/branchff-release-1.12/src/k8s.io/kubernetes$ /src/prin '3f102c3980' Skipping security_layer::hosted_map extensions... COMMITS: 3f102c3980 (initial) (cherrypicks) LATENCY TO APPEAR (DAYS) TAG K8S --- --- v1.13.0 49.22 v1.13.0-alpha.1 3.10 v1.13.0-alpha.2 11.62 v1.13.0-alpha.3 18.57 v1.13.0-beta.0 26.01 v1.13.0-beta.1 35.42 v1.13.0-beta.2 41.26 v1.13.0-rc.1 46.32 v1.13.0-rc.2 47.36 v1.13.1 60.78 v1.13.1-beta.0 52.10 v1.13.2 88.56 v1.13.2-beta.0 61.67 v1.13.3 111.97 v1.13.3-beta.0 90.21 v1.13.4 137.53 v1.13.4-beta.0 112.06 v1.13.5-beta.0 138.79 v1.14.0-alpha.0 25.94 v1.14.0-alpha.1 94.68 v1.14.0-alpha.2 108.62 v1.14.0-alpha.3 122.58 v1.14.0-beta.0 129.81 v1.14.0-beta.1 136.64 v1.15.0-alpha.0 129.77 user@b3a1b221edab:/usr/local/google/branchff-release-1.12/src/k8s.io/kubernetes$

Bubblemelon · 2019-03-02T04:21:16Z

README.md

+<br/> [`release-notes`](https://github.com/kubernetes/release/blob/master/cmd/release-notes) <br/><br/> | Scrape GitHub for release notes. See [Release Notes Gathering](#release-notes-gathering) for more information.
+<br/> [`prin`](https://github.com/kubernetes/release/blob/master/prin) <br/><br/> | What tags/releases is my PR IN?
+<br/> [`changelog-update`](https://github.com/kubernetes/release/blob/master/changelog-update) <br/><br/> | Updates [CHANGELOG.md](https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG.md) version entries by rescanning github for text and label changes.
+<br/> [`push-build.sh`](https://github.com/kubernetes/release/blob/master/push-build.sh) <br/><br/> | Pushes a developer (or CI) build up to GCS.


This one was also verbosely copied over, does CI mean the CI-Signal team?

"CI" in this context probably means "the CI system". In the description of the script they e.g. talk about jenkins, which as far as I know was the precursor of prow. I have never used that script and consider it outdated.

Oh okay, I get it now. I completely misinterpreted what that sentence meant, looking at push-build.sh when the sentence says, "developer" it actually means developer build and CI for Jenkins continuous builds ( exactly what you've pointed out 😅 ).

hoegaarden · 2019-03-02T12:53:16Z

/assign

hoegaarden

Thanks for doing this! I just found one litte typo ...

hoegaarden · 2019-03-02T12:54:16Z

README.md

+<br/> [`push-build.sh`](https://github.com/kubernetes/release/blob/master/push-build.sh) <br/><br/> | Pushes a developer (or CI) build up to GCS.
+<br/> [`script-template`](https://github.com/kubernetes/release/blob/master/script-template) <br/><br/> | Generates a script template in the kubernetes/release ecosystem.
+
+For information on how to use `gcbmgr`, `anago` and `branchoff`, see the [Branch Manager Handbook](https://github.com/kubernetes/sig-release/tree/master/release-team/role-handbooks/branch-manager#branch-manager-handbook)


Suggested change

For information on how to use `gcbmgr`, `anago` and `branchoff`, see the [Branch Manager Handbook](https://github.com/kubernetes/sig-release/tree/master/release-team/role-handbooks/branch-manager#branch-manager-handbook)

For information on how to use `gcbmgr`, `anago` and `branchff`, see the [Branch Manager Handbook](https://github.com/kubernetes/sig-release/tree/master/release-team/role-handbooks/branch-manager#branch-manager-handbook).

branchff stands for "branch fast forward"

Ohh typo! Thanks for catching that! 😊

If you'd quickly fix that (either by accepting this suggestion or pushing a commit which fixes that) we can get this whole PR merged. Let me know, if you need help!

hoegaarden · 2019-03-02T13:26:57Z

README.md

+[`branchff`](https://github.com/kubernetes/release/blob/master/branchff) | Fast-forward branching helper : <br/><br/> A tool used to pull new patches onto the release branch.
+<br/> [`find_green_build`](https://github.com/kubernetes/release/blob/master/find_green_build) <br/><br/> | Asks Jenkins for a good build to use.
+<br/> [`release-notes`](https://github.com/kubernetes/release/blob/master/cmd/release-notes) <br/><br/> | Scrape GitHub for release notes. See [Release Notes Gathering](#release-notes-gathering) for more information.
+<br/> [`prin`](https://github.com/kubernetes/release/blob/master/prin) <br/><br/> | What tags/releases is my PR IN?


Yes.

E.g. when I am in the directory of the k8s source and call the script with a random PR number or a random commit hash, it shows which tags those PR/commit is included in. However, I have never ever used that script before.

user@b3a1b221edab:/usr/local/google/branchff-release-1.12/src/k8s.io/kubernetes$ /src/prin '69500' Skipping security_layer::hosted_map extensions... COMMITS: 3f102c3980 (initial) (cherrypicks) (https://github.com/kubernetes/kubernetes/pull/69500) LATENCY TO APPEAR (DAYS) TAG K8S --- --- v1.13.0 49.22 v1.13.0-alpha.1 3.10 v1.13.0-alpha.2 11.62 v1.13.0-alpha.3 18.57 v1.13.0-beta.0 26.01 v1.13.0-beta.1 35.42 v1.13.0-beta.2 41.26 v1.13.0-rc.1 46.32 v1.13.0-rc.2 47.36 v1.13.1 60.78 v1.13.1-beta.0 52.10 v1.13.2 88.56 v1.13.2-beta.0 61.67 v1.13.3 111.97 v1.13.3-beta.0 90.21 v1.13.4 137.53 v1.13.4-beta.0 112.06 v1.13.5-beta.0 138.79 v1.14.0-alpha.0 25.94 v1.14.0-alpha.1 94.68 v1.14.0-alpha.2 108.62 v1.14.0-alpha.3 122.58 v1.14.0-beta.0 129.81 v1.14.0-beta.1 136.64 v1.15.0-alpha.0 129.77 user@b3a1b221edab:/usr/local/google/branchff-release-1.12/src/k8s.io/kubernetes$ /src/prin '3f102c3980' Skipping security_layer::hosted_map extensions... COMMITS: 3f102c3980 (initial) (cherrypicks) LATENCY TO APPEAR (DAYS) TAG K8S --- --- v1.13.0 49.22 v1.13.0-alpha.1 3.10 v1.13.0-alpha.2 11.62 v1.13.0-alpha.3 18.57 v1.13.0-beta.0 26.01 v1.13.0-beta.1 35.42 v1.13.0-beta.2 41.26 v1.13.0-rc.1 46.32 v1.13.0-rc.2 47.36 v1.13.1 60.78 v1.13.1-beta.0 52.10 v1.13.2 88.56 v1.13.2-beta.0 61.67 v1.13.3 111.97 v1.13.3-beta.0 90.21 v1.13.4 137.53 v1.13.4-beta.0 112.06 v1.13.5-beta.0 138.79 v1.14.0-alpha.0 25.94 v1.14.0-alpha.1 94.68 v1.14.0-alpha.2 108.62 v1.14.0-alpha.3 122.58 v1.14.0-beta.0 129.81 v1.14.0-beta.1 136.64 v1.15.0-alpha.0 129.77 user@b3a1b221edab:/usr/local/google/branchff-release-1.12/src/k8s.io/kubernetes$

hoegaarden · 2019-03-02T13:36:06Z

README.md

+<br/> [`release-notes`](https://github.com/kubernetes/release/blob/master/cmd/release-notes) <br/><br/> | Scrape GitHub for release notes. See [Release Notes Gathering](#release-notes-gathering) for more information.
+<br/> [`prin`](https://github.com/kubernetes/release/blob/master/prin) <br/><br/> | What tags/releases is my PR IN?
+<br/> [`changelog-update`](https://github.com/kubernetes/release/blob/master/changelog-update) <br/><br/> | Updates [CHANGELOG.md](https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG.md) version entries by rescanning github for text and label changes.
+<br/> [`push-build.sh`](https://github.com/kubernetes/release/blob/master/push-build.sh) <br/><br/> | Pushes a developer (or CI) build up to GCS.


"CI" in this context probably means "the CI system". In the description of the script they e.g. talk about jenkins, which as far as I know was the precursor of prow. I have never used that script and consider it outdated.

Combines Primary Tools and All Tools, and also removes Common Workflows.

hoegaarden · 2019-03-04T20:21:16Z

/lgtm
/ok-to-test

/hold
... for a bit, to maybe get another pair of eyes on it.
/assign @dougm @tpepper

dougm

/lgtm

@hoegaarden could be that push-build.sh is obsolete, but if so can address that in a separate PR. It uses the same releaselib functions as anago, looks like push-build.sh could still be used to push developer builds to bucket/registry/etc. other than the release targets. But I haven't used it either.

k8s-ci-robot · 2019-03-04T21:03:00Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Bubblemelon, dougm, hoegaarden

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:

~~OWNERS~~ [dougm,hoegaarden]

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

hoegaarden · 2019-03-05T11:06:46Z

Thanks @dougm ... will probably check on deprecating some tools in a separate PR.

/hold cancel

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Mar 2, 2019

k8s-ci-robot requested review from AishSundar and tpepper March 2, 2019 04:17

k8s-ci-robot added area/release-eng Issues or PRs related to the Release Engineering subproject sig/release Categorizes an issue or PR as relevant to SIG Release. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Mar 2, 2019

Bubblemelon commented Mar 2, 2019

View reviewed changes

k8s-ci-robot assigned hoegaarden Mar 2, 2019

hoegaarden suggested changes Mar 2, 2019

View reviewed changes

Bubblemelon force-pushed the fix-readme-redundant-info branch from 127bd9f to e56a861 Compare March 4, 2019 18:15

Condense README sections

4fe7aa6

Combines Primary Tools and All Tools, and also removes Common Workflows.

Bubblemelon force-pushed the fix-readme-redundant-info branch from e56a861 to 4fe7aa6 Compare March 4, 2019 18:35

Bubblemelon mentioned this pull request Mar 4, 2019

Add link to Branch Manager Handbook #671

Closed

k8s-ci-robot added lgtm "Looks good to me", indicates that a PR is ready to be merged. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. labels Mar 4, 2019

k8s-ci-robot assigned dougm and tpepper Mar 4, 2019

dougm reviewed Mar 4, 2019

View reviewed changes

k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Mar 5, 2019

k8s-ci-robot merged commit fa05467 into kubernetes:master Mar 5, 2019

Bubblemelon mentioned this pull request Apr 1, 2019

REQUEST: New membership for bubblemelon kubernetes/org#670

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Condense README sections #673

Condense README sections #673

Bubblemelon commented Mar 2, 2019

k8s-ci-robot commented Mar 2, 2019

Bubblemelon left a comment

Bubblemelon Mar 2, 2019 •

edited

Loading

hoegaarden Mar 2, 2019

Bubblemelon Mar 2, 2019

hoegaarden Mar 2, 2019

Bubblemelon Mar 4, 2019

hoegaarden commented Mar 2, 2019

hoegaarden left a comment

hoegaarden Mar 2, 2019

Bubblemelon Mar 2, 2019

hoegaarden Mar 4, 2019

Bubblemelon Mar 4, 2019

hoegaarden Mar 2, 2019

hoegaarden Mar 2, 2019

hoegaarden commented Mar 4, 2019

dougm left a comment

k8s-ci-robot commented Mar 4, 2019

hoegaarden commented Mar 5, 2019

	For information on how to use `gcbmgr`, `anago` and `branchoff`, see the [Branch Manager Handbook](https://github.com/kubernetes/sig-release/tree/master/release-team/role-handbooks/branch-manager#branch-manager-handbook)
	For information on how to use `gcbmgr`, `anago` and `branchff`, see the [Branch Manager Handbook](https://github.com/kubernetes/sig-release/tree/master/release-team/role-handbooks/branch-manager#branch-manager-handbook).

Condense README sections #673

Condense README sections #673

Conversation

Bubblemelon commented Mar 2, 2019

k8s-ci-robot commented Mar 2, 2019

Bubblemelon left a comment

Choose a reason for hiding this comment

Bubblemelon Mar 2, 2019 • edited Loading

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

hoegaarden commented Mar 2, 2019

hoegaarden 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

hoegaarden commented Mar 4, 2019

dougm left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Mar 4, 2019

hoegaarden commented Mar 5, 2019

Bubblemelon Mar 2, 2019 •

edited

Loading