Skip to content

Add check for parameter yaml to ensure consistence with source #7592

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Cstandardlib wants to merge 2 commits into
base: develop
Choose a base branch
from
+32 −0
Open

Add check for parameter yaml to ensure consistence with source #7592

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
801359e
Add check for parameter yaml to ensure consistence with source
Cstandardlib Jul 4, 2026
ff7c191
Merge branch 'develop' into docs/yml
Cstandardlib Jul 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions .github/workflows/build_test_cmake.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,3 +78,35 @@ jobs:
rm -rf build
cmake -B build -G Ninja ${{ matrix.build_args }}
cmake --build build -j $(nproc)

- name: Check parameters.yaml consistency
if: matrix.tag == 'gnu' && matrix.build_args == ''
run: |
ABACUS_BIN=$(find build -maxdepth 1 -name "abacus_*" -type f -executable | head -1)
if [ -z "${ABACUS_BIN}" ]; then
echo "ERROR: Could not find abacus binary in build/"
exit 1
fi
echo "Using binary: ${ABACUS_BIN}"
${ABACUS_BIN} --generate-parameters-yaml > /tmp/parameters_generated.yaml
if ! diff -q docs/parameters.yaml /tmp/parameters_generated.yaml; then
echo ""
echo "============================================"
echo "ERROR: docs/parameters.yaml is out of sync!"
echo "============================================"
echo ""
echo "The committed parameters.yaml does not match the parameter"
echo "metadata embedded in the C++ source code. This usually means"
echo "a developer modified Input_Item definitions in"
echo "source/source_io/module_parameter/read_input_item_*.cpp"
echo "but forgot to regenerate the YAML file."
echo ""
echo "To fix, run the following commands locally:"
echo ""
echo " \${ABACUS_BIN} --generate-parameters-yaml > docs/parameters.yaml"
echo ""
echo "--- Diff ( < committed | > generated ) ---"
diff docs/parameters.yaml /tmp/parameters_generated.yaml || true
exit 1
fi
echo "parameters.yaml is up-to-date."
Loading