Test markdown changelog creation in CI

Extract a github action to install the same version used in the release
workflow.  In future we should probably migrate to requirements.txt
or similar.

(cherry picked from commit 127c02992d)
This commit is contained in:
Johannes Altmanninger
2025-09-24 08:20:08 +02:00
parent a6698098db
commit d530e127f5
4 changed files with 21 additions and 1 deletions

View File

@@ -0,0 +1,10 @@
name: Install sphinx-markdown-builder
permissions:
contents: read
runs:
using: "composite"
steps:
- run: pip install sphinx-markdown-builder==0.6.8
shell: bash

View File

@@ -22,6 +22,7 @@ jobs:
sudo apt install gettext libpcre2-dev python3-pexpect tmux
# Generate a locale that uses a comma as decimal separator.
sudo locale-gen fr_FR.UTF-8
- uses: ./.github/actions/install-sphinx-markdown-builder
- name: cmake
run: |
mkdir build && cd build

View File

@@ -42,12 +42,12 @@ jobs:
ref: ${{ inputs.version }}
- name: Install dependencies
run: sudo apt install cmake gettext ninja-build python3-pip python3-sphinx
- uses: ./.github/actions/install-sphinx-markdown-builder
- name: Create tarball
run: |
set -x
mkdir /tmp/fish-built
FISH_ARTEFACT_PATH=/tmp/fish-built ./build_tools/make_tarball.sh
pip install sphinx-markdown-builder==0.6.8
relnotes=/tmp/fish-built/release-notes.md
sh -x ./build_tools/release-notes.sh >"$relnotes"
# Delete title

View File

@@ -0,0 +1,9 @@
#RUN: %fish %s
#REQUIRES: command -v sphinx-build
#REQUIRES: python -c 'import sphinx_markdown_builder'
set -l build_script (status dirname)/../../build_tools/release-notes.sh
$build_script -q >relnotes.md
or echo "Failed to build Markdown release notes."
sed -n 1p relnotes.md
# CHECK: ## fish {{.*}} (released {{.*}})