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

Release Notes Collection Picks Up Incorrect Text #3516

Open
npolshakova opened this issue Mar 18, 2024 · 4 comments
Open

Release Notes Collection Picks Up Incorrect Text #3516

npolshakova opened this issue Mar 18, 2024 · 4 comments
Labels
area/release-eng Issues or PRs related to the Release Engineering subproject kind/bug Categorizes issue or PR as related to a bug. needs-priority sig/release Categorizes an issue or PR as relevant to SIG Release.

Comments

@npolshakova
Copy link

npolshakova commented Mar 18, 2024

What happened:

Release notes collection automation has resulted in incorrect text and markdown being collected: kubernetes/sig-release#2449 (comment)

You can see examples of this merged in sig-release for 1.30 due to past release notes collection:

Updated examples from 1.29 that are still in the repo after 1.30 was cleaned up:

What you expected to happen:

This release note should not be collected since it is empty:

 "123082": {
    "commit": "d29f38efd83f5dcf18870c8772b9a0bb68c56097",
    "text": "```\n\n#### Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:\n\n\u003c!--\nThis section can be blank if this pull request does not require a release note.\n\nWhen adding links which point to resources within git repositories, like\nKEPs or supporting documentation, please reference a specific commit and avoid\nlinking directly to the master branch. This ensures that links reference a\nspecific point in time, rather than a document that may change over time.\n\nSee here for guidance on getting permanent links to files: https://help.github.com/en/articles/getting-permanent-links-to-files\n\nPlease use the following format for linking documentation:\n- [KEP]: \u003clink\u003e\n- [Usage]: \u003clink\u003e\n- [Other doc]: \u003clink\u003e\n--\u003e",
    "markdown": "```\n  \n  #### Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:\n  \n  \u003c!--\n  This section can be blank if this pull request does not require a release note.\n  \n  When adding links which point to resources within git repositories, like\n  KEPs or supporting documentation, please reference a specific commit and avoid\n  linking directly to the master branch. This ensures that links reference a\n  specific point in time, rather than a document that may change over time.\n  \n  See here for guidance on getting permanent links to files: https://help.github.com/en/articles/getting-permanent-links-to-files\n  \n  Please use the following format for linking documentation:\n  - [KEP]: \u003clink\u003e\n  - [Usage]: \u003clink\u003e\n  - [Other doc]: \u003clink\u003e\n  --\u003e ([#123082](https://github.com/kubernetes/kubernetes/pull/123082), [@alexzielenski](https://github.com/alexzielenski)) [SIG API Machinery and Testing]",
    "author": "alexzielenski",
    "author_url": "https://github.com/alexzielenski",
    "pr_url": "https://github.com/kubernetes/kubernetes/pull/123082",
    "pr_number": 123082,
    "areas": [
      "test"
    ],
    "kinds": [
      "flake"
    ],
    "sigs": [
      "api-machinery",
      "testing"
    ],
    "duplicate": true,
    "do_not_publish": true
  },
@npolshakova npolshakova added area/release-eng Issues or PRs related to the Release Engineering subproject kind/bug Categorizes issue or PR as related to a bug. sig/release Categorizes an issue or PR as relevant to SIG Release. labels Mar 18, 2024
@saschagrunert
Copy link
Member

@npolshakova thank you for the bug report, are you considering to work on a fix?

@npolshakova
Copy link
Author

@npolshakova thank you for the bug report, are you considering to work on a fix?

I'd be interested, but I'm not super familiar with the code that does the release notes collection. Do you think this is an issue on the krel side here?

@saschagrunert
Copy link
Member

@npolshakova I assume it's part of the release notes gathering logic of this repository. We just need a reproducer to see what we can fix.

@npolshakova
Copy link
Author

I think the issue is in the regex in the exclude filter: https://github.com/kubernetes/release/pull/3523/files I'm able to reproduce it, but still need a fix for the regex.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/release-eng Issues or PRs related to the Release Engineering subproject kind/bug Categorizes issue or PR as related to a bug. needs-priority sig/release Categorizes an issue or PR as relevant to SIG Release.
Projects
None yet
Development

No branches or pull requests

3 participants