Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add relnotes in JSON to draft pull request #1821

Merged
merged 1 commit into from
Dec 12, 2020

Conversation

puerco
Copy link
Member

@puerco puerco commented Dec 7, 2020

What type of PR is this?

/kind feature

What this PR does / why we need it:

krel release-notes will now push the JSON version of the release notes draft to k/sig-release when generating the release notes draft pull request.

Which issue(s) this PR fixes:

Ref: #1087
Ref: kubernetes/sig-release#1373 (comment)

Special notes for your reviewer:

/hold until 1.20 is cut

Two details with this change:

  1. This PR will write the full version of the notes in JSON to be read and copied to the bucket by the change in Fetch remote JSON release notes for official releases #1815. But I think we need to generate the JSON file for the website, containing only the current tag's notes (like we used to do with these files here). I assume we will read these from each archived release. CCing Chris to keep everyone in the loop.
  2. The JSON file is not prettified. I think this is the right time to get rid of the npm prettifier dependency and switch to an all go solution. Let's discuss how we want/need the files to look like.

/cc @saschagrunert @wilsonehusin @cartyc

Does this PR introduce a user-facing change?

- The Release Notes draft pull request now includes the JSON version of the release notes draft which 

@k8s-ci-robot k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. kind/feature Categorizes issue or PR as related to a new feature. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-priority size/M Denotes a PR that changes 30-99 lines, ignoring generated files. area/release-eng Issues or PRs related to the Release Engineering subproject sig/release Categorizes an issue or PR as relevant to SIG Release. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Dec 7, 2020
Copy link
Member

@saschagrunert saschagrunert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code LGTM, but let me be your linter:

cmd/krel/cmd/release_notes.go:334:1: cyclomatic complexity 31 of func `createDraftPR` is high (> 30) (gocyclo)
func createDraftPR(repoPath, tag string) (err error) {
^

Signed-off-by: Adolfo García Veytia (Puerco) <adolfo.garcia@uservers.net>
@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Dec 7, 2020
@puerco
Copy link
Member Author

puerco commented Dec 7, 2020

I've split the commit creation to its own function to lower the complexity.

I'm thinking on doing a major refactor to krel release-notes to implement the client/implementation pattern now that we are doing some work on it again.

Copy link
Member

@saschagrunert saschagrunert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 7, 2020
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: puerco, saschagrunert

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:

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

@puerco
Copy link
Member Author

puerco commented Dec 12, 2020

/hold cancel

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Dec 12, 2020
@k8s-ci-robot k8s-ci-robot merged commit 20cbeeb into kubernetes:master Dec 12, 2020
@k8s-ci-robot k8s-ci-robot added this to the v1.21 milestone Dec 12, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/release-eng Issues or PRs related to the Release Engineering subproject cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/feature Categorizes issue or PR as related to a new feature. lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-priority release-note Denotes a PR that will be considered when it comes time to generate release notes. 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.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants