Add 'Check amalgamation' workflow (#3693)

2022-08-27 14:20:51 +02:00 · 2022-08-27 14:20:51 +02:00 · 4c8cdd7afc
parent 8fcdbf2e77
commit 4c8cdd7afc
1 changed files with 92 additions and 0 deletions
--- a/.github/workflows/check_amalgamation.yml
+++ b/.github/workflows/check_amalgamation.yml
@ -0,0 +1,92 @@
+name: "Check amalgamation"
+
+on:
+  pull_request_target:
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    env:
+      MAIN_DIR: ${{ github.workspace }}/main
+      INCLUDE_DIR: ${{ github.workspace }}/main/single_include/nlohmann
+      TOOL_DIR: ${{ github.workspace }}/tools/tools/amalgamate
+      ASTYLE_FLAGS: >
+        --style=allman --indent=spaces=4 --indent-modifiers --indent-switches --indent-preproc-block
+        --indent-preproc-define --indent-col1-comments --pad-oper --pad-header --align-pointer=type
+        --align-reference=type --add-brackets --convert-tabs --close-templates --lineend=linux --preserve-date
+        --formatted
+
+    steps:
+      - name: Checkout pull request
+        uses: actions/checkout@v3
+        with:
+          path: main
+          ref: ${{ github.event.pull_request.head.sha }}
+
+      - name: Checkout tools
+        uses: actions/checkout@v3
+        with:
+          path: tools
+          ref: develop
+
+      - name: Install astyle
+        run: |
+          sudo apt-get update
+          sudo apt-get install astyle
+
+      - name: Check amalgamation
+        run: |
+          cd $MAIN_DIR
+
+          rm -fr $INCLUDE_DIR/json.hpp~ $INCLUDE_DIR/json_fwd.hpp~
+          cp $INCLUDE_DIR/json.hpp $INCLUDE_DIR/json.hpp~
+          cp $INCLUDE_DIR/json_fwd.hpp $INCLUDE_DIR/json_fwd.hpp~
+
+          python3 $TOOL_DIR/amalgamate.py -c $TOOL_DIR/config_json.json -s .
+          python3 $TOOL_DIR/amalgamate.py -c $TOOL_DIR/config_json_fwd.json -s .
+          echo "Format (1)"
+          astyle $ASTYLE_FLAGS --suffix=none --quiet $INCLUDE_DIR/json.hpp $INCLUDE_DIR/json_fwd.hpp
+
+          diff $INCLUDE_DIR/json.hpp~ $INCLUDE_DIR/json.hpp
+          diff $INCLUDE_DIR/json_fwd.hpp~ $INCLUDE_DIR/json_fwd.hpp
+
+          astyle $ASTYLE_FLAGS $(find docs/examples include tests -type f \( -name '*.hpp' -o -name '*.cpp' -o -name '*.cu' \) -not -path 'tests/thirdparty/*' -not -path 'tests/abi/include/nlohmann/*' | sort)
+          echo Check
+          find $MAIN_DIR -name '*.orig' -exec false {} \+
+
+      - name: Comment on pull request
+        if: failure()
+        uses: actions/github-script@v6
+        with:
+          github-token: ${{secrets.GITHUB_TOKEN}}
+          script: |
+            const author = context.payload.pull_request.user.login
+            const opts = github.rest.issues.listForRepo.endpoint.merge({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              creator: author,
+              state: 'all'
+            })
+
+            let first = true
+            const issues = await github.paginate(opts)
+            for (const issue of issues) {
+              if (issue.number === context.issue.number) {
+                continue
+              }
+
+              if (issue.pull_request) {
+                first = false
+                break
+              }
+            }
+
+            await github.rest.issues.createComment({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: '## 🔴 Amalgamation check failed! 🔴\nThe source code has not been amalgamated.'
+                    + (first ? ' @' + author + ' Please read and follow the [Contribution Guidelines]'
+                               + '(https://github.com/nlohmann/json/blob/develop/.github/CONTRIBUTING.md#files-to-change).'
+                             : '')
+              })