IMPORTANT: New changelog style in git starting 23th June
Hi all, We're updating the way we write the changelog entries in Uyuni and spacewalk repositories in git. TL;DR: Starting 23.06, you must write your changelog entries into a newly created file named as "<packagename>.changes.<author>.<featurename>". This file must reside in the same directory as the master changelog (.changes) file. Editing the master changelog file directly is not allowed anymore. GitHub "Changelogs" action will be updated to test against this new style. I introduced a new helper script `rel-eng/bin/mkchlog` to automatically create new changelog files with proper naming. You can add `rel-eng/bin` to your $PATH and use the script conveniently from any subdirectory of any package to create entries for that package. It can either be used as `mkchlog "My changelog entry text"` or without any argument. In the latter case, it opens a text editor for you to input your entries into the newly created file. It can be run multiple times to add multiple entries. You can run `mkchlog --help` for complete usage instructions. When does it start? To allow everyone to merge their PRs without having to change them, we are announcing a deadline of 2 weeks before we enforce this change. The tooling and the tests will be updated on 23 June 2023. If you have any open PRs then, you will have to update it to use the new changelog style. If you have any open PRs, please consider finalizing and merging them before the deadline. Why do we do this? The master changelog files (.changes) are the most frequently modified files in all our PRs. This causes us to constantly have merge conflicts in almost every PR. Using personal files this way will prevent this and allow for smoother merges and a better development experience. What is being changed? - GitHub "Changelogs" action * Master changelog files cannot be modified directly * Changelog entries must be added as dedicated changelog files named conveniently as <packagename>.changes.<author>.<feature>. Example: susemanager.changes.cbbayburt.my_new_feature At the moment, the suggested filename style is just by convention. The test does not strictly enforce the author and the feature parts. It will pass as long as the file has any suffix after ".changes" part. * Workflow only runs for the 'master' and the release branches, ignoring feature branches. The test will run when pulling the feature branch into 'master'. * Workflow only runs for directories that have a changelog file. * Workflow is simplified, and the output is made more user-friendly. - Release Engineering: tito [2] * tito is updated to compile every changelog file into the master changelog (.changes) file. - New devtool: "mkchlog" [1] Recommended way to create changelog entries. Just add `rel-eng/bin/` to your $PATH and run `mkchlog --help` for usage instructions. - Uyuni wiki page: Contributing [3] Page updated with new instructions All the listed changes will be rolled out on the 23th of June. I hope you'll find the new style convenient in your day-to-day experience. Please feel free to reach out to me for any feedback, questions, or issues. Cheers, Can [1] https://github.com/uyuni-project/uyuni/pull/7065 [2] https://github.com/cbbayburt/tito/pull/1 [3] https://github.com/uyuni-project/uyuni/wiki/Contributing#changelog-rules-for...
participants (1)
-
Can Bulut Bayburt