Sig-release: Auto-generated release notes file has bugs

Created on 20 Apr 2021  路  6Comments  路  Source: kubernetes/sig-release

What happened:

Auto-generated release notes file (being served in here) has bugs.

What you expected to happen:

[As-is]

## Changelog since v1.20.0

# Release notes for v1.21.0-rc.0

[Documentation](https://docs.k8s.io/docs/home)

# Changelog since v1.20.0

## What's New (Major Themes)

### Deprecation of PodSecurityPolicy

[To-be]

## Changelog since v1.20.0

## What's New (Major Themes)

### Deprecation of PodSecurityPolicy

[As-is]

## Dependencies

### Added
...

### Changed
...

### Removed
...

## Dependencies <!-- Duplicate -->

### Added <!-- Duplicate -->
...

### Changed <!-- Duplicate -->
...

### Removed <!-- Duplicate -->
...

[To-be]

## Dependencies

### Added
...

### Changed
...

### Removed
...

[As-is]

## Downloads for v1.21.0

filename | sha512 hash
-------- | -----------

[To-be]

## Downloads for v1.21.0

### Source Code

filename | sha512 hash
-------- | -----------

How to see the bugs:

Anything else we need to know?:

Environment:

  • Cloud provider or hardware configuration:
  • OS (e.g: cat /etc/os-release):
  • Kernel (e.g. uname -a):
  • Others:
kinbug needs-priority sirelease

Most helpful comment

so I think this bug should go to k/release because the actual tool which generates these documents are in that repository.

@jihoon-seo would you be interested to contribute code as well? let me know and we can work on it together, I'm @wilsonehusin on Kubernetes Slack 馃槂

(of course @pmmalinov01 you're invited too)

All 6 comments

That is interesting. I know about PR https://github.com/kubernetes/kubernetes/pull/100968 that should fix the current release notes and remove duplication and not needed items. Maybe, the kubernetes.io has not picked the fixed changelog?
/cc wilsonehusin

CC: @wilsonehusin

ouch i didn't realize this is happening in k/website too. thanks for bringing this up @jihoon-seo!

the fix should be pretty close to what @pmmalinov01 mentioned. if anyone would like to take it, you're welcome to. otherwise i will get to this sometime this weekend!

Maybe, the kubernetes.io has not picked the fixed changelog?

馃 looks like k/website part was manually done by the docs team of release team, which makes sense that they picked up the one with bug because we didn't catch the k/k bug until a day after or so.

in other words, sending a PR to k/website is the right move now.

so I think this bug should go to k/release because the actual tool which generates these documents are in that repository.

@jihoon-seo would you be interested to contribute code as well? let me know and we can work on it together, I'm @wilsonehusin on Kubernetes Slack 馃槂

(of course @pmmalinov01 you're invited too)

I opened an issue https://github.com/kubernetes/release/issues/2012,
so I am going to close this issue.
Thank you @pmmalinov01 and @wilsonehusin !

Was this page helpful?
0 / 5 - 0 ratings