Skip to content
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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

build: add changelogs for Linux packaging #1185

wants to merge 3 commits into from

Conversation

allan2
Copy link
Contributor

@allan2 allan2 commented Jan 10, 2025

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

Copy link

Let maintainers know that an action is required on their side

  • Add the label release-required Please cut a new release (Devolutions Gateway, Devolutions Agent, Jetsocat, PowerShell module) when you request a maintainer to cut a new release (Devolutions Gateway, Devolutions Agent, Jetsocat, PowerShell module)

  • Add the label release-blocker Follow-up is required before cutting a new release if a follow-up is required before cutting a new release

  • Add the label publish-required Please publish libraries (`Devolutions.Gateway.Utils`, OpenAPI clients, etc) when you request a maintainer to publish libraries (Devolutions.Gateway.Utils, OpenAPI clients, etc.)

  • Add the label publish-blocker Follow-up is required before publishing libraries if a follow-up is required before publishing libraries

@CBenoit CBenoit requested a review from thenextman January 10, 2025 21:16
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
Copy link
Member

@CBenoit CBenoit left a 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.

Comment on lines +822 to +828
$s = New-Changelog `
-Format 'Deb' `
-InputFile $UpstreamChangelogFile `
-Packager $Packager `
-Email $Email `
-PackageName $PkgName `
-Distro $DistroCodeName
Copy link
Member

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?

Copy link
Member

Choose a reason for hiding this comment

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

Seems fine to me 🤷‍♂️

Copy link
Member

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?

Copy link
Member

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.

@thenextman
Copy link
Member

Agree with @CBenoit, nice job!

There are some failures in the CI to address

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants