Fix for major version jumps

Author: Dariquest

ci/scripts/autobump-dependencies.py

@@ -21,7 +21,7 @@
 # Pinned versions for the resolvers. See use at the bottom.
 KEEPALIVED_VERSION = "2.3"
 SOCAT_VERSION = "1"
-HAPROXY_VERSION = "2.8"
+HAPROXY_VERSION = "3.2"
 LUA_VERSION = "5.4"
 PCRE_VERSION = "10"
 HATOP_VERSION = "0"
@@ -150,6 +150,12 @@ def fetch_latest_release(self) -> Release:
         """
         raise NotImplementedError
 
+    def get_release_notes(self) -> str:
+        """
+        Obtain changelog for the given current and latest release difference. This is useful to attach to the PR.
+        """
+        raise NotImplementedError
+
     def remove_current_blob(self):
         current_blob_path = f"{self.package}/{self.name}-{self.current_version}.tar.gz"
         if self._check_blob_exists(current_blob_path):
@@ -183,8 +189,8 @@ def open_pr_exists(self) -> bool:
         prs_exist = False
 
         for pr in self.remote_repo.get_pulls(
-            state="open", base=PR_BASE, head=f"{PR_ORG}:{self.pr_branch}"
-        ):  # theoretically there shold never be more than one open PR, print them anyways
+                state="open", base=PR_BASE, head=f"{PR_ORG}:{self.pr_branch}"
+        ):  # theoretically there should never be more than one open PR, print them anyways
             print(f"Open {self.pr_branch} PR exists: {pr.html_url}")
             prs_exist = True
         return prs_exist
@@ -196,8 +202,8 @@ def create_pr(self):
             Automatic bump from version {self.current_version} to version {self.latest_release.version}, downloaded from {self.latest_release.url}.
 
             After merge, consider releasing a new version of haproxy-boshrelease.
-        """
-        )
+        """) + self.get_release_notes()
+
         if not DRY_RUN:
             self._create_branch(self.remote_repo, self.pr_branch)
 
@@ -285,6 +291,9 @@ def get_release_download_url(rel):
 
         return latest_release
 
+    def get_release_notes(self) -> str:
+        return ""
+
 
 @dataclass
 class WebLinkDependency(Dependency):
@@ -320,6 +329,9 @@ def fetch_latest_release(self) -> Release:
 
         raise Exception(f"Failed to get latest {self.name} version from {self.root_url}")
 
+    def get_release_notes(self) -> str:
+        return ""
+
 
 @dataclass
 class HaproxyDependency(Dependency):
@@ -344,6 +356,80 @@ def fetch_latest_release(self) -> Release:
             version.parse(latest_version),
         )
 
+    # Parse, validate and split version into parts
+    def _parse_and_split_version(self, version):
+        version_parts = version.split('.')
+        if len(version_parts) < 3:
+            raise Exception(f"Expected version with 3 semver segments (major.minor.patch), got less: {version}.")
+        return version_parts[0], version_parts[1], version_parts[2]
+
+    # Returns normalized versions for changelog comparison
+    def _get_comparison_versions(self, current_version, latest_version):
+        comparison_current = str(current_version)
+        comparison_latest = str(latest_version)
+
+        current_major, current_minor, current_patch = self._parse_and_split_version(comparison_current)
+        latest_major, latest_minor, latest_patch = self._parse_and_split_version(comparison_latest)
+
+        # Major version jump adjustment to the zero version
+        if int(latest_major) > int(current_major):
+            comparison_current = f"{current_major}.{current_minor}.0"
+
+        return comparison_current, comparison_latest
+
+    def get_release_notes(self) -> str:
+        current_version = self.current_version
+        latest_version = self.latest_release.version
+
+        if (current_version == latest_version):
+            raise Exception(f"""Changelog requested but current and latest versions are the same: {current_version}""")
+
+        releaseNote = textwrap.dedent(f"""
+            [Changelog for HAProxy {latest_version}](https://www.haproxy.org/download/{HAPROXY_VERSION}/src/CHANGELOG).
+
+            Please also check list of [known open bugs for HAProxy {latest_version}](https://www.haproxy.org/bugs/bugs-{latest_version}.html).
+
+            The developer's summary for this release can be found in [the Announcement post for the HAProxy {latest_version} release](https://www.mail-archive.com/search?l=haproxy%40formilux.org&q=announce+subject%3A%22[ANNOUNCE]+haproxy-{latest_version}%22+-subject%3A%22re:%22).
+        """)
+
+        wget(f"""https://www.haproxy.org/download/{HAPROXY_VERSION}/src/CHANGELOG""", "HAPROXY-CHANGELOG")
+        with open('HAPROXY-CHANGELOG', 'r') as file:
+            releaseNote += textwrap.dedent(f"""
+                <details>
+
+                <summary>HAPROXY CHANGELOG between {latest_version} and {current_version}</summary>
+
+                ```
+            """)
+
+            # Get normalized versions for comparison
+            comparison_current, comparison_latest = self._get_comparison_versions(current_version, latest_version)
+
+            startCopy = False
+            for line in file:
+                if (line.endswith(comparison_latest+"\n")):          # Start copying from latest version head
+                    startCopy = True
+                if (line.endswith(comparison_current+"\n")):         # Stop when reaching current version
+                    break
+                if not startCopy:
+                    continue
+                releaseNote += line
+            # PR body length is limited by 65536 characters, truncating the change log to 60000 to avoid a validation error
+            releaseNoteLimit = 60000
+            if len(releaseNote) > releaseNoteLimit:
+                releaseNote = releaseNote[:releaseNoteLimit] + textwrap.dedent(f"""
+                
+                    Change log was trimmed to {releaseNoteLimit} characters. Please see the changelog file for the full change log.
+                """)
+
+            releaseNote += textwrap.dedent(f"""
+                ```
+
+                </details>""")
+
+        return releaseNote
+
+
 
 def wget(url: str, path: str, auth: Optional[Tuple[str, str]] = None):
     """
@@ -454,4 +540,4 @@ def main() -> None:
 
 
 if __name__ == "__main__":
-    main()
+    main()