ci: Add changelog creation before nightly release

Author: donmor

.github/changelog.entries

@@ -1,2 +1,2 @@
-chore: test entry text 2
-chore: test entry text
+  * chore: test entry text 2
+  * chore: test entry text

.github/scripts/release.py

@@ -4,6 +4,7 @@
 import subprocess
 import sys
 from datetime import datetime
+from email import utils
 import xml.etree.ElementTree as xml
 import json
 
@@ -112,6 +113,22 @@ def gh_get_last_nightly_tag():
     return next(gh_list_nightly_tags(16), None)
 
 
+def deb_changelog(version, revision, date, fullname='ruffle', email='[email protected]', suite='unstable'):
+    orig = ''
+    changes = ''
+    rfc2822date = utils.format_datetime(date)
+    with open(f'{REPO_DIR}/.github/changelog.entries', 'r') as changelog:
+        changes = changelog.read()
+    with open(f'{REPO_DIR}/desktop/packages/linux/debian/changelog', 'r') as original:
+        orig = original.read()
+    with open(f'{REPO_DIR}/desktop/packages/linux/debian/changelog', 'w') as modified:
+        modified.write(f'ruffle ({version}-{revision}) {suite}; urgency=medium\n\n{changes}\n\n -- {fullname} <{email}>  {rfc2822date}\n\n{orig}')
+    # Validate
+    with open(f'{REPO_DIR}/desktop/packages/linux/debian/changelog', 'r') as original:
+        orig = original.read()
+        log(orig)
+
+
 # ===== Commands ===========================================
 
 def bump():
@@ -129,7 +146,8 @@ def bump():
 
     log(f'Next planned version is {next_planned_version}')
 
-    nightly_version = f'{next_planned_version}-nightly.{get_current_time_version()}'
+    current_time_version = get_current_time_version()
+    nightly_version = f'{next_planned_version}-nightly.{current_time_version}'
     log(f'Nightly version is {nightly_version}')
 
     cargo_set_version([nightly_version])
@@ -146,6 +164,8 @@ def bump():
     github_output('version', version)
     github_output('version4', version4)
 
+    deb_changelog(next_planned_version, ''.join(part.zfill(2) for part in current_time_version.split('.')), datetime.now())
+
 
 def metainfo():
     metainfo_path1 = f'{REPO_DIR}/desktop/packages/linux/rs.ruffle.Ruffle.metainfo.xml'

.github/workflows/release_nightly.yml

@@ -54,10 +54,44 @@ jobs:
           crate: cargo-get
           version: '^1.0'
 
+      - name: Get changelog
+        uses: mikepenz/[email protected]
+        with:
+          owner: "ruffle-rs"
+          repo: "ruffle"
+          fromTag: "nightly-2025-12-01"
+          toTag: "nightly-2025-12-02"
+          token: ${{ secrets.PGITHUB_TOKEN }}
+          outputFile: "./.github/changelog.entries"
+          failOnError: "true"
+          configurationJson: |
+            {
+              "template": "#{{UNCATEGORIZED}}",
+              "pr_template": "  * #{{TITLE}} by @#{{AUTHOR}} in ##{{NUMBER}}",
+              "categories": []
+            }
+      - name: Get changelog
+        uses: mikepenz/[email protected]
+        with:
+          owner: "ruffle-rs"
+          repo: "ruffle"
+          fromTag: "nightly-2025-12-01"
+          toTag: "nightly-2025-12-02"
+          token: ${{ secrets.PGITHUB_TOKEN }}
+          outputFile: "./.github/changelog.entries.new"
+          failOnError: "true"
+          configurationJson: |
+            {
+              "template": "#{{UNCATEGORIZED}}",
+              "pr_template": "  * #{{TITLE}} by @#{{AUTHOR}} in ##{{NUMBER}}",
+              "categories": []
+            }
       - name: Bump version
         if: steps.activity.outputs.is_active == 'true'
         id: version
         run: |
+          cat .github/changelog.entries
+          cat .github/changelog.entries.new
           $RELEASE_SCRIPT bump
           # Ensure newlines at the end of file
           shopt -s globstar

Makefile

@@ -59,8 +59,8 @@ version:
 	  sed $(SI) '1i\\' $(DEBIAN_DIR)/changelog; \
 	  sed $(SI) '1i\ -- $(DEBFULLNAME) <$(DEBEMAIL)>  $(DEBDATE)' $(DEBIAN_DIR)/changelog; \
 	  sed $(SI) '1i\\' $(DEBIAN_DIR)/changelog; \
-	  cat .github/changelog.entries | while read line; do \
-	    sed $(SI) "1i\ \ * $$line" $(DEBIAN_DIR)/changelog; \
+	  tac .github/changelog.entries | while read line; do \
+	    sed $(SI) "1i$$line" $(DEBIAN_DIR)/changelog; \
 	  done; \
 	  sed $(SI) '1i\\' $(DEBIAN_DIR)/changelog; \
 	  sed $(SI) '1iruffle ($(VERSION)-$(REVISION)) $(DEBSUITE); urgency=medium' $(DEBIAN_DIR)/changelog; \