Conversation
|
The build and test suite have started for your pull request. To view your build log, please reference the build with source version: "PR_5953". Additionally, check the latest "dev" source version to identify existing test failures. Please note that you are not responsible for the test failures that exist on both your PR and the dev branch. |
|
The build and test suite have started for your pull request. To view your build log, please reference the build with source version: "PR_5953". Additionally, check the latest "dev" source version to identify existing test failures. Please note that you are not responsible for the test failures that exist on both your PR and the dev branch. |
|
The build and test suite have started for your pull request. To view your build log, please reference the build with source version: "PR_5953". Additionally, check the latest "dev" source version to identify existing test failures. Please note that you are not responsible for the test failures that exist on both your PR and the dev branch. |
|
The build and test suite have started for your pull request. To view your build log, please reference the build with source version: "PR_5953". Additionally, check the latest "dev" source version to identify existing test failures. Please note that you are not responsible for the test failures that exist on both your PR and the dev branch. |
|
I converted the following Unreleased issues to towncrier fragments. It would be good to know which of these are breaking and perhaps recategorize them? [Unreleased]Added
Changed
Fixed
|
|
The build and test suite have started for your pull request. To view your build log, please reference the build with source version: "PR_5953". Additionally, check the latest "dev" source version to identify existing test failures. Please note that you are not responsible for the test failures that exist on both your PR and the dev branch. |
CHANGELOG.md
Outdated
| in this format: {ISSUE_NUMBER}.{CHANGE_TYPE}.md (1234.change.md). | ||
|
|
||
| If your change fixes two issues, make multiple fragments with the same line of text. | ||
| if your change is not related to an issue, begin the filename with a +, and try to make the name unique |
There was a problem hiding this comment.
lets be more specific, maybe +{alpha}.{change_type}.md so users have a clear name. We basically just keep incrementing a letter until release. +a.fix.md. +b.change.md, etc. if it goes past z then aa, ab, etc. this makes them show up at the in order with an ls and makes it obvious what the next one should be.
There was a problem hiding this comment.
~ krodriguez$ ls -l /tmp/changes/
total 0
-rw-r--r--@ 1 krodriguez wheel 0 Feb 2 12:04 +a.change.md
-rw-r--r--@ 1 krodriguez wheel 0 Feb 2 12:05 +b.change.md
-rw-r--r--@ 1 krodriguez wheel 0 Feb 2 12:05 1234.change.md
-rw-r--r--@ 1 krodriguez wheel 0 Feb 2 12:05 5546.change.mdas an example, you can ls so the next is +c.{change_type}.md
There was a problem hiding this comment.
I don't recommend +a, +b ... +aa, +ab, +ac... alone - a simple ordinal pattern like that could cause merge conflicts.
Earlier I had suggested combining a pattern with your username, that way, there's no conflicts with other people's entries. It would be easy to still accidentally conflict with your own separate PR though.
In this PR, I generated random 6-character hashes for the log entries I converted. That approach prevent conflicts, but doesn't preserve order.
Maybe I should recommend a timestamp? The more precise the timestamp, the less likely the conflict. down to minutes - conflict unlikely, maybe include seconds too just to be safe, like
20260202111504.fix.md
|
this doesn't need to wait for tests. |
2 participants
Description
This PR introduces Towncrier as a tool to manage the changelog.
New changelog entries shall be recorded in individual, one-line files called fragments (for example, 5953.misc.md). When a release is made, a maintainer or automated CICD will use the towncrier utility to compile any fragments for the release into a new changelog section.
Initially spurred on by a desire to avoid merge conflicts in LTS cherry-picking CICD.
Related Issue
How Has This Been Validated?
Towncrier configuration tested on local machine.
Types of changes
Checklist:
Licensing
This project is mostly composed of free and unencumbered software released into the public domain, and we are unlikely to accept contributions that are not also released into the public domain. Somewhere near the top of each file should have these words: