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 release notes JSON draft #1373

Merged
merged 1 commit into from
Dec 3, 2020

Conversation

saschagrunert
Copy link
Member

@saschagrunert saschagrunert commented Dec 3, 2020

What type of PR is this:

/kind feature

What this PR does / why we need it:

We will use this JSON draft as artifact during the release process,
which allows consumers to get a machine-readable format of the notes.

The notes have been generated via:

> release-notes --format=json \
    --maps-from=$GOPATH/src/k8s.io/sig-release/releases/release-1.20/release-notes/maps \
    --start-rev=v1.19.0 \
    --end-rev=v1.20.0-rc.0

Which issue(s) this PR fixes:

Refers to kubernetes/release#1087 and kubernetes/release#1815

Special notes for your reviewer:

/cc @wilsonehusin @puerco

We will use this JSON draft as artifact during the release process,
which allows consumers to get a machine-readable format of the notes.

The notes have been generated via:

```
> release-notes --format=json \
    --maps-from=$GOPATH/src/k8s.io/sig-release/releases/release-1.20/release-notes/maps \
    --start-rev=v1.19.0 \
    --end-rev=v1.20.0-rc.0
```

Signed-off-by: Sascha Grunert <sgrunert@suse.com>
@k8s-ci-robot k8s-ci-robot added 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/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. area/release-team Issues or PRs related to the release-team 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 3, 2020
Copy link
Contributor

@hasheddan hasheddan left a comment

Choose a reason for hiding this comment

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

/lgtm
/hold for assignees

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Dec 3, 2020
@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 3, 2020
@puerco
Copy link
Member

puerco commented Dec 3, 2020

Should be fine when paired #1731, that is unless more edits happen in the coming days (but we should have automated this by then)
/lgtm

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: hasheddan, 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

@wilsonehusin
Copy link
Contributor

oh interesting, I didn't know this workflow.

I made edits to the Markdown Draft PR directly on Markdown instead of krel because it was too many to go through sequentially when I already know rhe PR numbers to edit.

I'm guessing this command is running through the map instead of the markdown -- correct? if so, that means this JSON might be missing some entries which I added to Markdown manually 😐

@saschagrunert
Copy link
Member Author

saschagrunert commented Dec 3, 2020

oh interesting, I didn't know this workflow.

Are you referring to the mapping workflow itself? Do we lack documentation about it?

If it was about the JSON file, then this is new and we definitely have to update the docs. I can follow up on that one.

I made edits to the Markdown Draft PR directly on Markdown instead of krel because it was too many to go through sequentially when I already know rhe PR numbers to edit.

I'm guessing this command is running through the map instead of the markdown -- correct? if so, that means this JSON might be missing some entries which I added to Markdown manually 😐

We always had a gap between the manually edited release notes and the generated JSON in the past, so I guess it’s fine. In the future we can use the maps to synchronize both versions directly.

@wilsonehusin
Copy link
Contributor

Are you referring to the mapping workflow itself? Do we lack documentation about it?

JSON file 😄

We always had a gap between the manually edited release notes and the generated JSON in the past, so I guess it’s fine. In the future we can use the maps to synchronize both versions directly.

gotcha! LGTM

/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 3, 2020
@k8s-ci-robot k8s-ci-robot merged commit eb916dd into kubernetes:master Dec 3, 2020
@k8s-ci-robot k8s-ci-robot added this to the v1.20 milestone Dec 3, 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-team Issues or PRs related to the release-team 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 sig/release Categorizes an issue or PR as relevant to SIG Release. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants