Skip to content

Conversation

@MaciejKaras
Copy link
Collaborator

@MaciejKaras MaciejKaras commented Sep 15, 2025

Summary

Based on discussions we had here we have decided to drop title from changelog files frontmatter. This gives false assumption that it will be included in the final Release Notes, which is not the case. Additionally title didn't have any meaningful usage. Now it will be added as initial contents of the file and dropped from frontmatter.

Proof of Work

Creating a changelog after updating:

(venv) ➜  mongodb-kubernetes git:(maciejk/ar-changelog-remove-title) python3 -m scripts.release.create_changelog -k feature "Test something that is very long title about some feature" -e
Created changelog entry at: /Users/maciej.karas/mongodb/mongodb-kubernetes/changelog/20250915_feature_test_something_that_is_very_long_title_about_some.md

(venv) ➜  mongodb-kubernetes git:(maciejk/ar-changelog-remove-title) ✗ cat changelog/20250915_feature_test_something_that_is_very_long_title_about_some.md
---
kind: feature
date: 2025-09-15
---

* Test something that is very long title about some feature

(venv) ➜  mongodb-kubernetes git:(maciejk/ar-changelog-remove-title) python3 -m scripts.release.release_notes --initial-version 1.2.0
# MCK 1.4.0 Release Notes

## New Features

* Some feature that is properly described with full context

Checklist

  • Have you linked a jira ticket and/or is the ticket in the title?
  • Have you checked whether your jira ticket required DOCSP changes?
  • Have you added changelog file?

@MaciejKaras MaciejKaras added the skip-changelog Use this label in Pull Request to not require new changelog entry file label Sep 15, 2025
@github-actions
Copy link

⚠️ (this preview might not be accurate if the PR is not rebased on current master branch)

MCK 1.3.1 Release Notes

@MaciejKaras MaciejKaras marked this pull request as ready for review September 15, 2025 09:15
@MaciejKaras MaciejKaras requested a review from a team as a code owner September 15, 2025 09:15
Copy link
Collaborator

@vinilage vinilage left a comment

Choose a reason for hiding this comment

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

LGTM

@MaciejKaras MaciejKaras merged commit ac396ac into master Sep 15, 2025
35 of 37 checks passed
@MaciejKaras MaciejKaras deleted the maciejk/ar-changelog-remove-title branch September 15, 2025 13:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

skip-changelog Use this label in Pull Request to not require new changelog entry file

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants