-
Notifications
You must be signed in to change notification settings - Fork 117
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Create GitHub action for checking MethodDoc.C is generated when functions.rst is changed.
- Loading branch information
1 parent
b976f78
commit b1090c1
Showing
1 changed file
with
69 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
name: Check sync of functions.rst and MethodDoc.C | ||
|
||
on: | ||
pull_request: | ||
paths: | ||
- 'src/doc/python_scripting/functions.rst' | ||
- 'src/visitpy/common/MethodDoc.C' | ||
- 'src/visitpy/common/MethodDoc.h' | ||
|
||
jobs: | ||
check-sync: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
|
||
- name: Set up Python | ||
uses: actions/setup-python@v2 | ||
with: | ||
python-version: '3.9' | ||
|
||
- name: Checkout code | ||
uses: actions/checkout@v2 | ||
|
||
- name: Get Changed Files (for PRs) | ||
id: changed-files | ||
uses: tj-actions/changed-files@v42 | ||
with: | ||
separator: ' ' | ||
|
||
- name: Check synced files | ||
run: | | ||
have_func_rst=0 | ||
have_methdoc_c=0 | ||
for f in ${{ steps.changed-files.outputs.all_changed_files }}; do | ||
if [[ "$f" == "src/doc/python_script/functions.rst" ]]; then | ||
have_func_rst=1 | ||
elif [[ "$f" == "src/visitpy/common/MethodDoc.C" ]]; then | ||
have_methdoc_c=1 | ||
fi | ||
done | ||
if [[ $have_func_rst -ne 0 ]]; then | ||
if [[ $have_methdoc_c -eq 0 ]]; then | ||
echo "Error: Changes to functions.rst require regeneration of MethodDoc.C (and possibly MethodDoc.h)" | ||
echo " Please follow https://visit-sphinx-github-user-manual.readthedocs.io/en/develop/dev_manual/UpdatingPythonDocStrings.html" | ||
exit 1 | ||
fi | ||
fi | ||
if [[ $have_methdoc_c -ne 0 ]]; then | ||
if [[ $have_func_rst -eq 0 ]]; then | ||
echo "Error: You have made changes directly to a *generated* file, MethodDoc.C." | ||
echo " You must make your changes to functions.rst and regenerate MethodDoc.C (and possibly MethodDoc.h)." | ||
echo " Please follow https://visit-sphinx-github-user-manual.readthedocs.io/en/develop/dev_manual/UpdatingPythonDocStrings.html" | ||
exit 1 | ||
fi | ||
fi | ||
- name: Check Generated MethodDoc.C | ||
run: | | ||
cp src/visitpy/common/MethodDoc.C src/visitpy/common/MethodDoc.C.orig | ||
pushd src/doc | ||
./functions_to_plain_py.py | ||
2to3 -p PY_RST_FUNCTIONS_TO_PYTHON.py | ||
./functions_to_method_doc.py | ||
diff --brief src/visitpy/common/MethodDoc.C src/visitpy/common/MethodDoc.C.orig | ||
if [ $? -ne 0 ]; then | ||
echo "Error: MethodDoc.C does not appear to have been generated from functions.rst" | ||
echo " Please follow https://visit-sphinx-github-user-manual.readthedocs.io/en/develop/dev_manual/UpdatingPythonDocStrings.html" | ||
exit 1 | ||
fi |