Commit ac396ac
authored
CLOUDP-295785 - remove title from changelog file generator (#451)
# Summary
Based on discussions we had
[here](https://mongodb.slack.com/archives/CGLP6R2PQ/p1757923176704559?thread_ts=1757920788.967209&cid=CGLP6R2PQ)
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
- [x] Have you linked a jira ticket and/or is the ticket in the title?
- [x] Have you checked whether your jira ticket required DOCSP changes?
- [x] Have you added changelog file?
- use `skip-changelog` label if not needed
- refer to [Changelog files and Release
Notes](https://github.com/mongodb/mongodb-kubernetes/blob/master/CONTRIBUTING.md#changelog-files-and-release-notes)
section in CONTRIBUTING.md for more details1 parent 4bcba59 commit ac396ac
File tree
4 files changed
+6
-8
lines changed- scripts/release
- tests
4 files changed
+6
-8
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
18 | 18 | | |
19 | 19 | | |
20 | 20 | | |
21 | | - | |
| 21 | + | |
22 | 22 | | |
23 | 23 | | |
24 | 24 | | |
| |||
34 | 34 | | |
35 | 35 | | |
36 | 36 | | |
37 | | - | |
| 37 | + | |
38 | 38 | | |
39 | 39 | | |
40 | 40 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
35 | 35 | | |
36 | 36 | | |
37 | 37 | | |
38 | | - | |
| 38 | + | |
39 | 39 | | |
40 | 40 | | |
41 | | - | |
42 | 41 | | |
43 | 42 | | |
44 | 43 | | |
| |||
129 | 128 | | |
130 | 129 | | |
131 | 130 | | |
132 | | - | |
| 131 | + | |
133 | 132 | | |
134 | 133 | | |
135 | 134 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
53 | 53 | | |
54 | 54 | | |
55 | 55 | | |
56 | | - | |
| 56 | + | |
57 | 57 | | |
58 | 58 | | |
59 | 59 | | |
| |||
72 | 72 | | |
73 | 73 | | |
74 | 74 | | |
75 | | - | |
76 | 75 | | |
77 | 76 | | |
78 | 77 | | |
| 78 | + | |
79 | 79 | | |
80 | 80 | | |
81 | 81 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
69 | 69 | | |
70 | 70 | | |
71 | 71 | | |
72 | | - | |
73 | 72 | | |
74 | 73 | | |
75 | 74 | | |
| |||
0 commit comments