Skip to content

Kibana release notes grouped by team label#258941

Draft
lcawl wants to merge 30 commits intoelastic:mainfrom
lcawl:team-rn-test
Draft

Kibana release notes grouped by team label#258941
lcawl wants to merge 30 commits intoelastic:mainfrom
lcawl:team-rn-test

Conversation

@lcawl
Copy link
Copy Markdown
Contributor

@lcawl lcawl commented Mar 20, 2026

This is a test PR that will not be merged.
It is a variation of #250840 that uses only Team:xxx labels (and :ml) to derive the changelog areas and products.

Steps to test

  1. Check out Improve changelog rule logic when config must apply to multiple products docs-builder#2961 (since there was a bug related to multi-product rules)
    1. Run ./build.sh clean and .build.sh publishbinaries to get an artifact for testing purposes.
  2. Create a lot of changelogs. This is when the pivot.areas, pivot.products, and pivot.types mappings from PR label to changelog field will take effect. I ran these commands from the kibana repo:
    1. Create some changelogs from PRs that were associated with the Kibana release notes:
      /path/to/docs-builder/.artifacts/publish/docs-builder/release/docs-builder changelog add \
      --prs ./docs/9.3.0-kibana.txt --strip-title-prefix
      This command will return the following expected warning:
      > Warning: [-exclude] Skipping changelog creation for PR https://github.com/elastic/kibana/pull/233289 due to blocking label 'release_note:skip' (match: any).
    2. Create some changelogs from PRs that were associated with the Security release notes:
       /path/to/docs-builder/.artifacts/publish/docs-builder/release/docs-builder changelog add \
       --prs ./docs/9.3.0-security.txt --strip-title-prefix
    3. Ditto for Observability:
       /path/to/.artifacts/publish/docs-builder/release/docs-builder changelog add \
       --prs ./docs/9.3.0-observability.txt --strip-title-prefix
  3. Check for interest's sake how many of the changelogs are missing products or areas:
    • Every changelog file has at least one valid product: value.
    • 131 changelog files are missing an areas section (they define products: but have no areas: field with values).
  4. Create release bundles. This is when the rules.bundle section of the changelog config file will take effect.
    1. For Kibana release notes:
       /path/to/.artifacts/publish/docs-builder/release/docs-builder changelog bundle kibana-release 9.3.0 ./docs/9.3.0-kibana.txt 
      Due to the current rules.bundle.products.kibana or other reasons (e.g. changelog wasn't created because of "skip" labels), 113 PRs from that list were not included in the release bundle. For example:
      Warning: [-bundle-type-area] Excluding '247082.yaml' from bundle (type/area filter).
      NOTE: docs/changelog/247082.yaml
      0 Errors / 113 Warnings / 0 Hints
    2. For Security release notes:
      /path/to/docs-builder/.artifacts/publish/docs-builder/release/docs-builder changelog bundle security-release 9.3.0 ./docs/9.3.0-security.txt
      Due to the current rules.bundle.products.security or other reasons (e.g. changelog wasn't created because of "skip" labels), 9 PRs from that list were not included in the release bundle. For example:
      > Warning: [-bundle-type-area] Excluding '245030.yaml' from bundle (type/area filter).
      NOTE: docs/changelog/245030.yaml
      
      0 Errors / 9 Warnings / 0 Hints
    3. For Observability release notes:
      /path/to/docs-builder/.artifacts/publish/docs-builder/release/docs-builder changelog bundle observability-release 9.3.0 ./docs/9.3.0-observability.txt
      Due to the current rules.bundle.products.observability or other reasons (e.g. changelog wasn't created because of "skip" labels), 42 PRs from that list were not included in the release bundle. For example:
      > Warning: [-bundle-type-area] Excluding '242019.yaml' from bundle (type/area filter).
      NOTE: docs/changelog/242019.yaml
      
      0 Errors / 42 Warnings / 0 Hints
  5. To see these bundles in the existing release notes, ensure that there are changelog directives in the markdown files. For Observability and Security, go to Security and Observability release notes grouped by team label docs-content#5582

@elasticmachine
Copy link
Copy Markdown
Contributor

🤖 Jobs for this PR can be triggered through checkboxes. 🚧

ℹ️ To trigger the CI, please tick the checkbox below 👇

  • Click to trigger kibana-pull-request for this PR!
  • Click to trigger kibana-deploy-project-from-pr for this PR!
  • Click to trigger kibana-deploy-cloud-from-pr for this PR!
  • Click to trigger kibana-entity-store-performance-from-pr for this PR!
  • Click to trigger kibana-storybooks-from-pr for this PR!

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 20, 2026

Vale Linting Results

Summary: 3 errors, 12 warnings, 17 suggestions found

❌ Errors (3)
File Line Rule Message
docs/release-notes/index.md 477 Elastic.ConflictMarkers Do not commit Git merge conflict markers in source code.
docs/release-notes/index.md 562 Elastic.ConflictMarkers Do not commit Git merge conflict markers in source code.
docs/release-notes/index.md 564 Elastic.ConflictMarkers Do not commit Git merge conflict markers in source code.
⚠️ Warnings (12)
File Line Rule Message
docs/release-notes/_snippets/9.3.0/index.md 7 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
docs/release-notes/_snippets/9.3.0/index.md 53 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
docs/release-notes/_snippets/9.3.0/index.md 65 Elastic.QuotesPunctuation Place punctuation inside closing quotation marks.
docs/release-notes/_snippets/9.3.0/index.md 65 Elastic.QuotesPunctuation Place punctuation inside closing quotation marks.
docs/release-notes/_snippets/9.3.0/index.md 68 Elastic.QuotesPunctuation Place punctuation inside closing quotation marks.
docs/release-notes/_snippets/9.3.0/index.md 68 Elastic.QuotesPunctuation Place punctuation inside closing quotation marks.
docs/release-notes/_snippets/9.3.0/index.md 68 Elastic.QuotesPunctuation Place punctuation inside closing quotation marks.
docs/release-notes/_snippets/9.3.0/index.md 289 Elastic.QuotesPunctuation Place punctuation inside closing quotation marks.
docs/release-notes/_snippets/9.3.0/index.md 343 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'.
docs/release-notes/_snippets/9.3.0/index.md 593 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
docs/release-notes/_snippets/9.3.0/index.md 619 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
docs/release-notes/_snippets/9.3.0/index.md 619 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
💡 Suggestions (17)
File Line Rule Message
docs/release-notes/_snippets/9.3.0/index.md 10 Elastic.WordChoice Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'see', unless the term is in the UI.
docs/release-notes/_snippets/9.3.0/index.md 43 Elastic.WordChoice Consider using 'turn off, silence' instead of 'mute', unless the term is in the UI.
docs/release-notes/_snippets/9.3.0/index.md 51 Elastic.WordChoice Consider using 'deactivate, deselect, hide, turn off' instead of 'Disable', unless the term is in the UI.
docs/release-notes/_snippets/9.3.0/index.md 70 Elastic.Clone Use clone only when referring to cloning a GitHub repository or creating a copy that is linked to the original. Often confused with 'copy' and 'duplicate'.
docs/release-notes/_snippets/9.3.0/index.md 76 Elastic.WordChoice Consider using 'can, might' instead of 'may', unless the term is in the UI.
docs/release-notes/_snippets/9.3.0/index.md 232 Elastic.WordChoice Consider using 'deactivate, deselect, hide, turn off' instead of 'Disable', unless the term is in the UI.
docs/release-notes/_snippets/9.3.0/index.md 233 Elastic.WordChoice Consider using 'deactivated, deselected, hidden, turned off, unavailable' instead of 'disabled', unless the term is in the UI.
docs/release-notes/_snippets/9.3.0/index.md 248 Elastic.WordChoice Consider using 'stop, cancel, end' instead of 'abort', unless the term is in the UI.
docs/release-notes/_snippets/9.3.0/index.md 284 Elastic.WordChoice Consider using 'deactivate, deselect, hide, turn off' instead of 'Disable', unless the term is in the UI.
docs/release-notes/_snippets/9.3.0/index.md 296 Elastic.WordChoice Consider using 'deactivated, deselected, hidden, turned off, unavailable' instead of 'disabled', unless the term is in the UI.
docs/release-notes/_snippets/9.3.0/index.md 297 Elastic.Clone Use Cloned only when referring to cloning a GitHub repository or creating a copy that is linked to the original. Often confused with 'copy' and 'duplicate'.
docs/release-notes/_snippets/9.3.0/index.md 337 Elastic.WordChoice Consider using 'deactivate, deselect, hide, turn off' instead of 'Disable', unless the term is in the UI.
docs/release-notes/_snippets/9.3.0/index.md 394 Elastic.WordChoice Consider using 'cannot' instead of 'unable', unless the term is in the UI.
docs/release-notes/_snippets/9.3.0/index.md 571 Elastic.WordChoice Consider using 'deactivate, deselect, hide, turn off' instead of 'Disable', unless the term is in the UI.
docs/release-notes/_snippets/9.3.0/index.md 585 Elastic.Wordiness Consider using 'all' instead of 'all of '.
docs/release-notes/_snippets/9.3.0/index.md 590 Elastic.WordChoice Consider using 'deactivate, deselect, hide, turn off' instead of 'Disable', unless the term is in the UI.
docs/release-notes/_snippets/9.3.0/index.md 637 Elastic.WordChoice Consider using 'deactivated, deselected, hidden, turned off, unavailable' instead of 'Disabled', unless the term is in the UI.

The Vale linter checks documentation changes against the Elastic Docs style guide.

To use Vale locally or report issues, refer to Elastic style guide for Vale.

@github-actions
Copy link
Copy Markdown
Contributor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants