-
Notifications
You must be signed in to change notification settings - Fork 13
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
build: add changelogs for Linux packaging #1185
base: master
Are you sure you want to change the base?
Conversation
Let maintainers know that an action is required on their side
|
This commit: - adds an upstream changelog to Debian and RPM packages - populates the packaging changelog for Debian (previously included but empty) - adds the packaging changelog for RPM Upstream changelogs are generated from the root CHANGELOG.md. Change notes for all products are included in each upstream changelog. Packaging changelogs are created in product folders within `package`. More details are found in the comments of `ci/linux-changelog.ps1`. Some additional changes are made for compliance: - Benoît is listed as the packager - revision number changed from `.0` to `.1` - this affects the names of the generated assets - `devolutions-agent_2024.3.6.0_amd64.deb` -> `devolutions-agent_2024.3.6-1_amd64.deb` - Debian changelog urgency changed from `low` to `medium` - `medium` is the standard value These small fixes are also included: - `dh_compress` level changed from 9 to 10 - this is to fix a warning; levels before 10 are deprecated - fixed a date format typo in root CHANGELOG.md Issue: DGW-237
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is looking like excellent work to me!
I appreciate the small test suite for the linux-changelog.ps1 script. I’m unsure about where this should live, but let’s keep it at this place as it’s obvious enough.
As future work, it would be nice to run these tests in the CI too.
$s = New-Changelog ` | ||
-Format 'Deb' ` | ||
-InputFile $UpstreamChangelogFile ` | ||
-Packager $Packager ` | ||
-Email $Email ` | ||
-PackageName $PkgName ` | ||
-Distro $DistroCodeName |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nitpick: Not sure if this is the conventional formatting for multi-line commands?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Seems fine to me 🤷♂️
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
question: Is it possible that we don’t commit the changelog files since it’s derived from the root one?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is the packaging changelog, not the product changelog, so it's right that this is committed? The product changelog is generated.
Agree with @CBenoit, nice job! There are some failures in the CI to address |
This commit:
Upstream changelogs are generated from the root CHANGELOG.md.
Change notes for all products are included in each upstream changelog.
Packaging changelogs are created in product folders within
package
.More details are found in the comments of
ci/linux-changelog.ps1
.Some additional changes are made for compliance:
.0
to.1
devolutions-agent_2024.3.6.0_amd64.deb
->devolutions-agent_2024.3.6-1_amd64.deb
low
tomedium
medium
is the standard valueThese small fixes are also included:
dh_compress
level changed from 9 to 10Issue: DGW-237