From 6131abd34387dabee25a0efe2d1806d038b4602c Mon Sep 17 00:00:00 2001
From: Ronnie Dutta <61982285+MetRonnie@users.noreply.github.com>
Date: Mon, 14 Aug 2023 16:33:13 +0100
Subject: [PATCH] GH Actions: automatically add changelog line for updated UI
 version

---
 .github/workflows/update_ui.yml    | 8 ++++++++
 changes.d/changelog-template.jinja | 6 +++++-
 pyproject.toml                     | 4 ++++
 3 files changed, 17 insertions(+), 1 deletion(-)

diff --git a/.github/workflows/update_ui.yml b/.github/workflows/update_ui.yml
index cc679669..1f7a4bce 100644
--- a/.github/workflows/update_ui.yml
+++ b/.github/workflows/update_ui.yml
@@ -55,6 +55,14 @@ jobs:
             git commit -m "ui: install ${version}"
           done
 
+      - name: Add to changelog
+        if: inputs.install
+        run: |
+          python3 -m pip install -q towncrier
+          towncrier create +.ui-version.md --content "Updated cylc-ui to ${{ inputs.install }}"
+          git add changes.d
+          commit --amend --no-edit
+
       - name: push
         run: |
           git push origin "$HEAD_BRANCH"
diff --git a/changes.d/changelog-template.jinja b/changes.d/changelog-template.jinja
index 9a965126..c2fc9e27 100644
--- a/changes.d/changelog-template.jinja
+++ b/changes.d/changelog-template.jinja
@@ -1,5 +1,9 @@
 {% if sections[""] %}
-{% for category, val in definitions.items() if category in sections[""] %}
+{% if "ui-version" in sections[""] %}
+[{{ sections[""]["ui-version"].keys()|first }}](https://github.com/cylc/cylc-ui/blob/master/CHANGES.md)
+
+{% endif %}
+{% for category, val in definitions.items() if category in sections[""] and category != "ui-version" %}
 ### {{ definitions[category]['name'] }}
 
 {% for text, pulls in sections[""][category].items() %}
diff --git a/pyproject.toml b/pyproject.toml
index 9e17cdb1..9a583248 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -30,6 +30,10 @@ showcontent = true
 directory = "fix"
 name = "🔧 Fixes"
 showcontent = true
+[[tool.towncrier.type]]
+directory = "ui-version"
+name = "UI version"
+showcontent = true
 
 
 [tool.pytest.ini_options]