asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
virtualx-engine/.github/workflows/static_checks.yml

112 lines
4.5 KiB
YAML
Raw Normal View History

GitHub Actions: Prepend emoji to platform names for easy visual grepping
2020-08-22 23:04:57 +02:00
name: 📊 Static Checks
ci: wait for static check results before starting builds
2023-04-04 15:56:53 +02:00
on:
workflow_call:
Add static formatting checks for GitHub Actions
2020-07-13 09:34:34 +02:00
CI: Cancel previous builds if new commit is pushed
2021-08-24 20:49:06 +02:00
concurrency:
Fix CI after concurrency
2021-08-25 15:04:05 +02:00
group: ci-${{github.actor}}-${{github.head_ref || github.run_number}}-${{github.ref}}-static
CI: Cancel previous builds if new commit is pushed
2021-08-24 20:49:06 +02:00
cancel-in-progress: true
Add static formatting checks for GitHub Actions
2020-07-13 09:34:34 +02:00
jobs:
added MacOS and Linux to GitHub Actions
2020-07-15 00:37:02 +02:00
static-checks:
CI: Speed up static checks by checking only changed files - file_format, header_guards and clang-format benefit from this short list. - dotnet-format, Python and JS checks don't, but they're only relevant for PRs changing a specific set of files, so we skip them when those files aren't modified. The logic to get changed files only works reliably for: - Pull request events - Non-force pushed push events So when force pushing a branch in your fork, or creating a new branch, it will still scan all files as fallback. Upgraded CI runner to Ubuntu 22.04 so we get clang-format 14 out of the box, so we don't need to install a custom version (saves ~15 s). We also cache the APT dependencies to speed up the build and avoid flaky Ubuntu/Microsoft repos.
2023-04-19 15:10:36 +02:00
name: Code style, file formatting, and docs
runs-on: ubuntu-22.04
Add static formatting checks for GitHub Actions
2020-07-13 09:34:34 +02:00
steps:
- name: Checkout
CI: Bump various GitHub actions to latest versions actions/cache@v3 actions/checkout@v3 actions/upload-artifact@v3 actions/setup-dotnet@v2 actions/setup-java@v3 actions/setup-python@v4 mymindstorm/setup-emsdk@v11 Also reset cache keys as we're going to cleanup all caches.
2022-08-25 13:44:22 +02:00
uses: actions/checkout@v3
CI: Speed up static checks by checking only changed files - file_format, header_guards and clang-format benefit from this short list. - dotnet-format, Python and JS checks don't, but they're only relevant for PRs changing a specific set of files, so we skip them when those files aren't modified. The logic to get changed files only works reliably for: - Pull request events - Non-force pushed push events So when force pushing a branch in your fork, or creating a new branch, it will still scan all files as fallback. Upgraded CI runner to Ubuntu 22.04 so we get clang-format 14 out of the box, so we don't need to install a custom version (saves ~15 s). We also cache the APT dependencies to speed up the build and avoid flaky Ubuntu/Microsoft repos.
2023-04-19 15:10:36 +02:00
with:
fetch-depth: 2
- name: Install APT dependencies
uses: awalsh128/cache-apt-pkgs-action@latest
with:
packages: dos2unix libxml2-utils moreutils
Add static formatting checks for GitHub Actions
2020-07-13 09:34:34 +02:00
CI: Speed up static checks by checking only changed files - file_format, header_guards and clang-format benefit from this short list. - dotnet-format, Python and JS checks don't, but they're only relevant for PRs changing a specific set of files, so we skip them when those files aren't modified. The logic to get changed files only works reliably for: - Pull request events - Non-force pushed push events So when force pushing a branch in your fork, or creating a new branch, it will still scan all files as fallback. Upgraded CI runner to Ubuntu 22.04 so we get clang-format 14 out of the box, so we don't need to install a custom version (saves ~15 s). We also cache the APT dependencies to speed up the build and avoid flaky Ubuntu/Microsoft repos.
2023-04-19 15:10:36 +02:00
- name: Install Python dependencies and general setup
CI: Properly exclude Azure repositories on Ubuntu Nuke all the pre-defined repos, we just need stock Ubuntu.
2020-08-11 17:14:47 +02:00
run: |
CI: Update static checks to black 23.3.0 And apply it to the codebase, removing empty lines at the start of blocks.
2023-06-19 23:33:02 +02:00
pip3 install black==23.3.0 pytest==7.1.2 mypy==0.971
CI: Visibly print trailing whitespace when static checks fail GitHub Actions seems to be hiding colored whitespace, and after lots of attempts I couldn't find a way to work it around. So instead I'm using a perl expression to replace trailing spaces with `·` and tabs with `<TAB>` in the ANSI colored diff output. This ensure that they're visible, and they are properly colored as expected too.
2023-04-05 13:51:38 +02:00
git config diff.wsErrorHighlight all
Add static formatting checks for GitHub Actions
2020-07-13 09:34:34 +02:00
CI: Speed up static checks by checking only changed files - file_format, header_guards and clang-format benefit from this short list. - dotnet-format, Python and JS checks don't, but they're only relevant for PRs changing a specific set of files, so we skip them when those files aren't modified. The logic to get changed files only works reliably for: - Pull request events - Non-force pushed push events So when force pushing a branch in your fork, or creating a new branch, it will still scan all files as fallback. Upgraded CI runner to Ubuntu 22.04 so we get clang-format 14 out of the box, so we don't need to install a custom version (saves ~15 s). We also cache the APT dependencies to speed up the build and avoid flaky Ubuntu/Microsoft repos.
2023-04-19 15:10:36 +02:00
- name: Get changed files
id: changed-files
CI: Use gh-cli for changed files, and workaround codespell skip list bug For PRs, this should give a more accurate list, as the previous method would diff to the tip of the `master` branch, which could include new commits (and thus changed files) not present in the PR branch. codespell's `--skip` option doesn't work at all with folders when used together with an explicit list of paths to work with, so let's not use it.
2023-05-08 14:49:51 +02:00
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
CI: Speed up static checks by checking only changed files - file_format, header_guards and clang-format benefit from this short list. - dotnet-format, Python and JS checks don't, but they're only relevant for PRs changing a specific set of files, so we skip them when those files aren't modified. The logic to get changed files only works reliably for: - Pull request events - Non-force pushed push events So when force pushing a branch in your fork, or creating a new branch, it will still scan all files as fallback. Upgraded CI runner to Ubuntu 22.04 so we get clang-format 14 out of the box, so we don't need to install a custom version (saves ~15 s). We also cache the APT dependencies to speed up the build and avoid flaky Ubuntu/Microsoft repos.
2023-04-19 15:10:36 +02:00
run: |
if [ "${{ github.event_name }}" == "pull_request" ]; then
CI: Use gh-cli for changed files, and workaround codespell skip list bug For PRs, this should give a more accurate list, as the previous method would diff to the tip of the `master` branch, which could include new commits (and thus changed files) not present in the PR branch. codespell's `--skip` option doesn't work at all with folders when used together with an explicit list of paths to work with, so let's not use it.
2023-05-08 14:49:51 +02:00
files=$(gh pr diff ${{ github.event.pull_request.number }} --name-only)
CI: Speed up static checks by checking only changed files - file_format, header_guards and clang-format benefit from this short list. - dotnet-format, Python and JS checks don't, but they're only relevant for PRs changing a specific set of files, so we skip them when those files aren't modified. The logic to get changed files only works reliably for: - Pull request events - Non-force pushed push events So when force pushing a branch in your fork, or creating a new branch, it will still scan all files as fallback. Upgraded CI runner to Ubuntu 22.04 so we get clang-format 14 out of the box, so we don't need to install a custom version (saves ~15 s). We also cache the APT dependencies to speed up the build and avoid flaky Ubuntu/Microsoft repos.
2023-04-19 15:10:36 +02:00
elif [ "${{ github.event_name }}" == "push" -a "${{ github.event.forced }}" == "false" -a "${{ github.event.created }}" == "false" ]; then
CI: Fixup failure to get changed files on merge The checkout might be too shallow so the before commit isn't available. The logic was already written to take this into account (it then generates an empty 'changed.txt' which falls back to testing everything), but the error code would still force terminate the job. Hopefully we can find a way to make the logic work for merge events too in the future, but for now this is a quick fix.
2023-04-20 17:51:53 +02:00
files=$(git diff-tree --no-commit-id --name-only -r ${{ github.event.before }}..${{ github.event.after }} 2> /dev/null || true)
CI: Speed up static checks by checking only changed files - file_format, header_guards and clang-format benefit from this short list. - dotnet-format, Python and JS checks don't, but they're only relevant for PRs changing a specific set of files, so we skip them when those files aren't modified. The logic to get changed files only works reliably for: - Pull request events - Non-force pushed push events So when force pushing a branch in your fork, or creating a new branch, it will still scan all files as fallback. Upgraded CI runner to Ubuntu 22.04 so we get clang-format 14 out of the box, so we don't need to install a custom version (saves ~15 s). We also cache the APT dependencies to speed up the build and avoid flaky Ubuntu/Microsoft repos.
2023-04-19 15:10:36 +02:00
fi
echo "$files" >> changed.txt
cat changed.txt
CI: Use gh-cli for changed files, and workaround codespell skip list bug For PRs, this should give a more accurate list, as the previous method would diff to the tip of the `master` branch, which could include new commits (and thus changed files) not present in the PR branch. codespell's `--skip` option doesn't work at all with folders when used together with an explicit list of paths to work with, so let's not use it.
2023-05-08 14:49:51 +02:00
files=$(echo "$files" | grep -v 'thirdparty' | xargs -I {} sh -c 'echo "./{}"' | tr '\n' ' ')
CI: Make codespell checks blocking, but only check changed files
2023-05-08 11:28:34 +02:00
echo "CHANGED_FILES=$files" >> $GITHUB_ENV
CI: Speed up static checks by checking only changed files - file_format, header_guards and clang-format benefit from this short list. - dotnet-format, Python and JS checks don't, but they're only relevant for PRs changing a specific set of files, so we skip them when those files aren't modified. The logic to get changed files only works reliably for: - Pull request events - Non-force pushed push events So when force pushing a branch in your fork, or creating a new branch, it will still scan all files as fallback. Upgraded CI runner to Ubuntu 22.04 so we get clang-format 14 out of the box, so we don't need to install a custom version (saves ~15 s). We also cache the APT dependencies to speed up the build and avoid flaky Ubuntu/Microsoft repos.
2023-04-19 15:10:36 +02:00
Add static formatting checks for GitHub Actions
2020-07-13 09:34:34 +02:00
- name: File formatting checks (file_format.sh)
run: |
CI: Speed up static checks by checking only changed files - file_format, header_guards and clang-format benefit from this short list. - dotnet-format, Python and JS checks don't, but they're only relevant for PRs changing a specific set of files, so we skip them when those files aren't modified. The logic to get changed files only works reliably for: - Pull request events - Non-force pushed push events So when force pushing a branch in your fork, or creating a new branch, it will still scan all files as fallback. Upgraded CI runner to Ubuntu 22.04 so we get clang-format 14 out of the box, so we don't need to install a custom version (saves ~15 s). We also cache the APT dependencies to speed up the build and avoid flaky Ubuntu/Microsoft repos.
2023-04-19 15:10:36 +02:00
bash ./misc/scripts/file_format.sh changed.txt
Add static formatting checks for GitHub Actions
2020-07-13 09:34:34 +02:00
Code quality: Fix header guards consistency Adds `header_guards.sh` bash script, used in CI to validate future changes. Can be run locally to fix invalid header guards.
2022-07-23 23:41:51 +02:00
- name: Header guards formatting checks (header_guards.sh)
run: |
CI: Speed up static checks by checking only changed files - file_format, header_guards and clang-format benefit from this short list. - dotnet-format, Python and JS checks don't, but they're only relevant for PRs changing a specific set of files, so we skip them when those files aren't modified. The logic to get changed files only works reliably for: - Pull request events - Non-force pushed push events So when force pushing a branch in your fork, or creating a new branch, it will still scan all files as fallback. Upgraded CI runner to Ubuntu 22.04 so we get clang-format 14 out of the box, so we don't need to install a custom version (saves ~15 s). We also cache the APT dependencies to speed up the build and avoid flaky Ubuntu/Microsoft repos.
2023-04-19 15:10:36 +02:00
bash ./misc/scripts/header_guards.sh changed.txt
Code quality: Fix header guards consistency Adds `header_guards.sh` bash script, used in CI to validate future changes. Can be run locally to fix invalid header guards.
2022-07-23 23:41:51 +02:00
Add static formatting checks for GitHub Actions
2020-07-13 09:34:34 +02:00
- name: Python style checks via black (black_format.sh)
run: |
CI: Fix checks fallback logic when changed files listing is missing The file would be one byte (newline) so the check with '-s' failed.
2023-04-20 18:16:38 +02:00
if grep -qE '\.py$|SConstruct|SCsub' changed.txt || [ -z "$(cat changed.txt)" ]; then
CI: Speed up static checks by checking only changed files - file_format, header_guards and clang-format benefit from this short list. - dotnet-format, Python and JS checks don't, but they're only relevant for PRs changing a specific set of files, so we skip them when those files aren't modified. The logic to get changed files only works reliably for: - Pull request events - Non-force pushed push events So when force pushing a branch in your fork, or creating a new branch, it will still scan all files as fallback. Upgraded CI runner to Ubuntu 22.04 so we get clang-format 14 out of the box, so we don't need to install a custom version (saves ~15 s). We also cache the APT dependencies to speed up the build and avoid flaky Ubuntu/Microsoft repos.
2023-04-19 15:10:36 +02:00
bash ./misc/scripts/black_format.sh
else
echo "Skipping Python formatting as no Python files were changed."
fi
Add static formatting checks for GitHub Actions
2020-07-13 09:34:34 +02:00
ci: add Python static analysis check via mypy
2022-08-23 15:21:46 +02:00
- name: Python scripts static analysis (mypy_check.sh)
run: |
CI: Fix checks fallback logic when changed files listing is missing The file would be one byte (newline) so the check with '-s' failed.
2023-04-20 18:16:38 +02:00
if grep -qE '\.py$|SConstruct|SCsub' changed.txt || [ -z "$(cat changed.txt)" ]; then
CI: Speed up static checks by checking only changed files - file_format, header_guards and clang-format benefit from this short list. - dotnet-format, Python and JS checks don't, but they're only relevant for PRs changing a specific set of files, so we skip them when those files aren't modified. The logic to get changed files only works reliably for: - Pull request events - Non-force pushed push events So when force pushing a branch in your fork, or creating a new branch, it will still scan all files as fallback. Upgraded CI runner to Ubuntu 22.04 so we get clang-format 14 out of the box, so we don't need to install a custom version (saves ~15 s). We also cache the APT dependencies to speed up the build and avoid flaky Ubuntu/Microsoft repos.
2023-04-19 15:10:36 +02:00
bash ./misc/scripts/mypy_check.sh
else
echo "Skipping Python static analysis as no Python files were changed."
fi
ci: add Python static analysis check via mypy
2022-08-23 15:21:46 +02:00
ci: add basic test pipeline for shader builders
2022-06-30 04:14:07 +02:00
- name: Python builders checks via pytest (pytest_builders.sh)
run: |
bash ./misc/scripts/pytest_builders.sh
[HTML5] Add jsdoc2rst tool. A template for `jsdoc` that generat the HTML5 public classref. The script can be run via `npm run docs` to print to stdout. You can dry run via `npm run docs -- --d dry-run` or write to file via `npm run docs -- -d /path/to/file.rst` Also update Makefile in `doc/` and add dry run test to CI.
2021-02-22 06:10:16 +01:00
- name: JavaScript style and documentation checks via ESLint and JSDoc
[HTML5] Enforce JavaScript style with eslint. Applies to javascript files inside the platform library folder, the exposed Engine code, and any javascript files in modules. Files ending with ".externs.js" will be ignored, you can create a ".eslintignore" file to specify extra files to be ignored.
2020-11-19 05:59:12 +01:00
run: |
CI: Fix checks fallback logic when changed files listing is missing The file would be one byte (newline) so the check with '-s' failed.
2023-04-20 18:16:38 +02:00
if grep -q "platform/web" changed.txt || [ -z "$(cat changed.txt)" ]; then
CI: Speed up static checks by checking only changed files - file_format, header_guards and clang-format benefit from this short list. - dotnet-format, Python and JS checks don't, but they're only relevant for PRs changing a specific set of files, so we skip them when those files aren't modified. The logic to get changed files only works reliably for: - Pull request events - Non-force pushed push events So when force pushing a branch in your fork, or creating a new branch, it will still scan all files as fallback. Upgraded CI runner to Ubuntu 22.04 so we get clang-format 14 out of the box, so we don't need to install a custom version (saves ~15 s). We also cache the APT dependencies to speed up the build and avoid flaky Ubuntu/Microsoft repos.
2023-04-19 15:10:36 +02:00
cd platform/web
npm ci
npm run lint
npm run docs -- -d dry-run
else
echo "Skipping JavaScript formatting as no Web/JS files were changed."
fi
[HTML5] Enforce JavaScript style with eslint. Applies to javascript files inside the platform library folder, the exposed Engine code, and any javascript files in modules. Files ending with ".externs.js" will be ignored, you can create a ".eslintignore" file to specify extra files to be ignored.
2020-11-19 05:59:12 +01:00
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-02-14 14:18:53 +01:00
- name: Class reference schema checks
run: |
[Export docs] Move docs to platform folders.
2023-04-19 11:23:22 +02:00
xmllint --noout --schema doc/class.xsd doc/classes/*.xml modules/*/doc_classes/*.xml platform/*/doc_classes/*.xml
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-02-14 14:18:53 +01:00
Add static formatting checks for GitHub Actions
2020-07-13 09:34:34 +02:00
- name: Documentation checks
run: |
Fix `doc_status.py` trying to get removed `version` tag from XML This also runs `doc_status.py` on CI to catch potential future regressions.
2023-07-13 05:20:44 +02:00
doc/tools/doc_status.py doc/classes modules/*/doc_classes platform/*/doc_classes
Create an "Editor-only" section in the online class reference This helps to find such classes without digging through the rest of the class reference. Editor-only classes can still be found under your normal "Node" and "Resource" types. This also fixes a typo and a missed case from the recent platform docs PR.
2023-04-24 21:06:55 +02:00
doc/tools/make_rst.py --dry-run --color doc/classes modules platform
ci: move slowest static job to the end of pipeline
2022-06-30 04:36:40 +02:00
- name: Style checks via clang-format (clang_format.sh)
run: |
CI: Speed up static checks by checking only changed files - file_format, header_guards and clang-format benefit from this short list. - dotnet-format, Python and JS checks don't, but they're only relevant for PRs changing a specific set of files, so we skip them when those files aren't modified. The logic to get changed files only works reliably for: - Pull request events - Non-force pushed push events So when force pushing a branch in your fork, or creating a new branch, it will still scan all files as fallback. Upgraded CI runner to Ubuntu 22.04 so we get clang-format 14 out of the box, so we don't need to install a custom version (saves ~15 s). We also cache the APT dependencies to speed up the build and avoid flaky Ubuntu/Microsoft repos.
2023-04-19 15:10:36 +02:00
clang-format --version
bash ./misc/scripts/clang_format.sh changed.txt
Add `dotnet format` to CI to check C# style
2022-08-27 03:14:27 +02:00
- name: Style checks via dotnet format (dotnet_format.sh)
run: |
CI: Fix checks fallback logic when changed files listing is missing The file would be one byte (newline) so the check with '-s' failed.
2023-04-20 18:16:38 +02:00
if grep -q "modules/mono" changed.txt || [ -z "$(cat changed.txt)" ]; then
CI: Speed up static checks by checking only changed files - file_format, header_guards and clang-format benefit from this short list. - dotnet-format, Python and JS checks don't, but they're only relevant for PRs changing a specific set of files, so we skip them when those files aren't modified. The logic to get changed files only works reliably for: - Pull request events - Non-force pushed push events So when force pushing a branch in your fork, or creating a new branch, it will still scan all files as fallback. Upgraded CI runner to Ubuntu 22.04 so we get clang-format 14 out of the box, so we don't need to install a custom version (saves ~15 s). We also cache the APT dependencies to speed up the build and avoid flaky Ubuntu/Microsoft repos.
2023-04-19 15:10:36 +02:00
bash ./misc/scripts/dotnet_format.sh
else
echo "Skipping dotnet format as no C# files were changed."
fi
CI: Add official codespell action with PR annotations
2023-02-01 10:50:52 +01:00
- name: Spell checks via codespell
CI: Skip codespell check if `CHANGED_FILES` is empty This can happen when only thirdparty files are changed, since we grep them out. Re-add `bin` and `thirdparty` to the skip list for good measure.
2023-05-10 09:44:35 +02:00
if: github.event_name == 'pull_request' && env.CHANGED_FILES != ''
Fix various typos with codespell And ignore some false positives introduced by recent versions of codespell.
2023-06-16 08:45:35 +02:00
uses: codespell-project/actions-codespell@v2
CI: Add official codespell action with PR annotations
2023-02-01 10:50:52 +01:00
with:
CI: Skip codespell check if `CHANGED_FILES` is empty This can happen when only thirdparty files are changed, since we grep them out. Re-add `bin` and `thirdparty` to the skip list for good measure.
2023-05-10 09:44:35 +02:00
skip: "./bin,./thirdparty,*.desktop,*.gen.*,*.po,*.pot,*.rc,./AUTHORS.md,./COPYRIGHT.txt,./DONORS.md,./core/input/gamecontrollerdb.txt,./core/string/locales.h,./editor/project_converter_3_to_4.cpp,./misc/scripts/codespell.sh,./platform/android/java/lib/src/com,./platform/web/node_modules,./platform/web/package-lock.json"
Fix various typos with codespell And ignore some false positives introduced by recent versions of codespell.
2023-06-16 08:45:35 +02:00
ignore_words_list: "curvelinear,doubleclick,expct,findn,gird,hel,inout,lod,mis,nd,numer,ot,requestor,te,vai"
CI: Make codespell checks blocking, but only check changed files
2023-05-08 11:28:34 +02:00
path: ${{ env.CHANGED_FILES }}
Reference in a new issue Copy permalink