Skip to content

Commit c5edb71

Browse files
authored
Assert Reference Manual generated content is in sync with template (hazelcast#1351)
`Reference_Manual.md.in` is a template used to generate `Reference_Manual.md` content. In hazelcast#1339, both files were changed, but not kept in sync - as such, the content of `Reference_Manual.md` is outdated. Changes: - added validation to PR builder that the generated `Reference_Manual.md` matches what's in the PR - [_example_ of the output produces when it fails](https://github.com/hazelcast/hazelcast-cpp-client/actions/runs/19048201782) - updated `Reference_Manual.md` to address the original issue
1 parent d06c189 commit c5edb71

File tree

2 files changed

+17
-642
lines changed

2 files changed

+17
-642
lines changed

.github/workflows/build-pr.yml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,16 @@ jobs:
115115
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
116116
HZ_TEST_AWS_INSTANCE_PRIVATE_IP: ${{ secrets.HZ_TEST_AWS_INSTANCE_PRIVATE_IP }}
117117

118+
# Tagged onto another build to avoid re-running the entire build to check separately
119+
- name: Check Reference Manual generated correctly
120+
run: |
121+
if ! git diff --quiet ${OUTPUT_REFERENCE_MANUAL_FILE}; then
122+
echo "::error file=${OUTPUT_REFERENCE_MANUAL_FILE}::File does not match generated version from template"
123+
exit 1
124+
fi
125+
env:
126+
OUTPUT_REFERENCE_MANUAL_FILE: Reference_Manual.md
127+
118128
shared-matrix:
119129
uses: ./.github/workflows/get-shared-matrix.yml
120130

0 commit comments

Comments
 (0)