Don't assume we are on the main branch when collecting release notes

Qiskit · Jun 26, 2023 · 70434d6 · 70434d6 · garrison · Jun 26, 2023
1 parent 0f08ee8
commit 70434d6
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -28,6 +28,11 @@ jobs:
           pip install tox
           sudo apt-get update
           sudo apt-get install -y pandoc
+      - name: Tell reno to name the upcoming release after the branch we are on
+        shell: bash
+        run: |
+          sed -i.bak -e '/unreleased_version_title:*/d' releasenotes/config.yaml
+          echo unreleased_version_title: \"Upcoming release \(\`\`${GITHUB_REF_NAME}\`\`\)\" >> releasenotes/config.yaml
       - name: Build docs
         shell: bash
         run: |

diff --git a/releasenotes/config.yaml b/releasenotes/config.yaml
@@ -1,5 +1,5 @@
 ---
 encoding: utf8
 default_branch: main
-unreleased_version_title: "Upcoming release (``main`` branch)"
+unreleased_version_title: "Upcoming release"
 earliest_version: 0.1.0