From 986086d7a9236e27afec0f078358a1be8f837b2d Mon Sep 17 00:00:00 2001 From: "ariel.s.adams" Date: Tue, 15 Jun 2021 08:05:35 -0500 Subject: [PATCH 01/12] Change Config --- .github/codeql/codeql-coding-standard.yml | 14 +------------- 1 file changed, 1 insertion(+), 13 deletions(-) diff --git a/.github/codeql/codeql-coding-standard.yml b/.github/codeql/codeql-coding-standard.yml index f68d01b42..c5d0c29a9 100644 --- a/.github/codeql/codeql-coding-standard.yml +++ b/.github/codeql/codeql-coding-standard.yml @@ -4,16 +4,4 @@ disable-default-queries: true queries: - name: JPL Rules - uses: github/codeql/cpp/ql/src/JPL_C@main - - name: MISRA Rule 9-5-1 - uses: github/codeql/cpp/ql/src/jsf/4.20 Unions and Bit Fields/AV Rule 153.ql@main - - name: MISRA Rule 5-18-1 - uses: github/codeql/cpp/ql/src/jsf/4.21 Operators/AV Rule 168.ql@main - - name: MISRA 6-2-2 - uses: github/codeql/cpp/ql/src/jsf/4.25 Expressions/AV Rule 202.ql@main - - name: MISRA Rule 5-14-1 - uses: github/codeql/cpp/ql/src/jsf/4.21 Operators/AV Rule 165.ql@main - - name: MISRA Rule 5-3-2 - uses: github/codeql/cpp/ql/src/jsf/4.21 Operators/AV Rule 165.ql@main - - name: MISRA Rule 7-5-2 - uses: github/codeql/cpp/ql/src/jsf/4.22 Pointers and References/AV Rule 173.ql@main \ No newline at end of file + uses: github/codeql/cpp/ql/src/JPL_C@main \ No newline at end of file From efa0d34411c4e5710c7a28fce2d351dfae5ac8db Mon Sep 17 00:00:00 2001 From: "ariel.s.adams" Date: Tue, 15 Jun 2021 08:15:35 -0500 Subject: [PATCH 02/12] Config 2 --- .github/codeql/codeql-coding-standard.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/codeql/codeql-coding-standard.yml b/.github/codeql/codeql-coding-standard.yml index c5d0c29a9..aacfb148f 100644 --- a/.github/codeql/codeql-coding-standard.yml +++ b/.github/codeql/codeql-coding-standard.yml @@ -3,5 +3,5 @@ name: "CodeQL Coding Standard Configuration File" disable-default-queries: true queries: - - name: JPL Rules - uses: github/codeql/cpp/ql/src/JPL_C@main \ No newline at end of file + - name: jsf Rules + uses: github/codeql/cpp/ql/src/jsf@main \ No newline at end of file From ef21437b96e0f79cadb5ae5d8cc9ca109b1ee442 Mon Sep 17 00:00:00 2001 From: Ariel Adams <69638935+ArielSAdamsNASA@users.noreply.github.com> Date: Tue, 15 Jun 2021 08:24:37 -0500 Subject: [PATCH 03/12] Create JSF.yml --- .github/workflows/JSF.yml | 82 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 82 insertions(+) create mode 100644 .github/workflows/JSF.yml diff --git a/.github/workflows/JSF.yml b/.github/workflows/JSF.yml new file mode 100644 index 000000000..38fa41051 --- /dev/null +++ b/.github/workflows/JSF.yml @@ -0,0 +1,82 @@ +name: "CodeQL Analysis" + +on: + push: + pull_request: + branches: + - main + +env: + SIMULATION: native + ENABLE_UNIT_TESTS: true + OMIT_DEPRECATED: true + BUILDTYPE: release + +jobs: + #Checks for duplicate actions. Skips push actions if there is a matching or duplicate pull-request action. + check-for-duplicates: + runs-on: ubuntu-latest + # Map a step output to a job output + outputs: + should_skip: ${{ steps.skip_check.outputs.should_skip }} + steps: + - id: skip_check + uses: fkirc/skip-duplicate-actions@master + with: + concurrent_skipping: 'same_content' + skip_after_successful_duplicate: 'true' + do_not_skip: '["pull_request", "workflow_dispatch", "schedule"]' + + CodeQL-Coding-Standard-Build: + #Continue if check-for-duplicates found no duplicates. Always runs for pull-requests. + needs: check-for-duplicates + if: ${{ needs.check-for-duplicates.outputs.should_skip != 'true' }} + runs-on: ubuntu-18.04 + timeout-minutes: 15 + + steps: + # Checks out a copy of your repository + - name: Checkout code + if: ${{ !steps.skip-workflow.outputs.skip }} + uses: actions/checkout@v2 + with: + repository: nasa/cFS + submodules: true + + - name: Check versions + if: ${{ !steps.skip-workflow.outputs.skip }} + run: | + git log -1 --pretty=oneline + git submodule + + - name: Checkout codeql code + if: ${{ !steps.skip-workflow.outputs.skip }} + uses: actions/checkout@v2 + with: + repository: github/codeql + submodules: true + path: codeql + + - name: Initialize CodeQL + if: ${{ !steps.skip-workflow.outputs.skip }} + uses: github/codeql-action/init@v1 + with: + languages: c + config-file: ArielSAdamsNASA/cFS/.github/codeql/codeql-coding-standard.yml@main + + # Setup the build system + - name: Copy sample_defs + if: ${{ !steps.skip-workflow.outputs.skip }} + run: | + cp ./cfe/cmake/Makefile.sample Makefile + cp -r ./cfe/cmake/sample_defs sample_defs + + # Setup the build system + - name: Make Install + if: ${{ !steps.skip-workflow.outputs.skip }} + run: make + + # Run CodeQL + - name: Perform CodeQL Analysis + if: ${{ !steps.skip-workflow.outputs.skip }} + uses: github/codeql-action/analyze@v1 From 6bf1b75c1a1cb867093715954ea2946eb0587c50 Mon Sep 17 00:00:00 2001 From: Ariel Adams <69638935+ArielSAdamsNASA@users.noreply.github.com> Date: Tue, 15 Jun 2021 09:44:42 -0500 Subject: [PATCH 04/12] Update JSF.yml --- .github/workflows/JSF.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/workflows/JSF.yml b/.github/workflows/JSF.yml index 38fa41051..e4878d5cc 100644 --- a/.github/workflows/JSF.yml +++ b/.github/workflows/JSF.yml @@ -3,8 +3,6 @@ name: "CodeQL Analysis" on: push: pull_request: - branches: - - main env: SIMULATION: native From 06e6afbca48796fdaf2eca5a128e455bdd847ff9 Mon Sep 17 00:00:00 2001 From: Ariel Adams <69638935+ArielSAdamsNASA@users.noreply.github.com> Date: Tue, 15 Jun 2021 09:45:41 -0500 Subject: [PATCH 05/12] JSF No Duplicate --- .github/workflows/JSF.yml | 21 ++------------------- 1 file changed, 2 insertions(+), 19 deletions(-) diff --git a/.github/workflows/JSF.yml b/.github/workflows/JSF.yml index e4878d5cc..3bc8b1fe5 100644 --- a/.github/workflows/JSF.yml +++ b/.github/workflows/JSF.yml @@ -1,4 +1,4 @@ -name: "CodeQL Analysis" +name: "CodeQL JSF Analysis" on: push: @@ -11,26 +11,9 @@ env: BUILDTYPE: release jobs: - #Checks for duplicate actions. Skips push actions if there is a matching or duplicate pull-request action. - check-for-duplicates: - runs-on: ubuntu-latest - # Map a step output to a job output - outputs: - should_skip: ${{ steps.skip_check.outputs.should_skip }} - steps: - - id: skip_check - uses: fkirc/skip-duplicate-actions@master - with: - concurrent_skipping: 'same_content' - skip_after_successful_duplicate: 'true' - do_not_skip: '["pull_request", "workflow_dispatch", "schedule"]' - - CodeQL-Coding-Standard-Build: + CodeQL-JSF-Build: #Continue if check-for-duplicates found no duplicates. Always runs for pull-requests. - needs: check-for-duplicates - if: ${{ needs.check-for-duplicates.outputs.should_skip != 'true' }} runs-on: ubuntu-18.04 - timeout-minutes: 15 steps: # Checks out a copy of your repository From 9f353a8591f176074615f0c2c732de553e2de260 Mon Sep 17 00:00:00 2001 From: Ariel Adams <69638935+ArielSAdamsNASA@users.noreply.github.com> Date: Tue, 15 Jun 2021 10:01:24 -0500 Subject: [PATCH 06/12] JSF Disable Main From 9cc65546bd54392b24a724bdec2a871c5bc5f0a9 Mon Sep 17 00:00:00 2001 From: "ariel.s.adams" Date: Tue, 6 Jul 2021 10:07:14 -0500 Subject: [PATCH 07/12] Fix #286, Documentation Duplicate Check --- .github/workflows/build-documentation.yml | 22 +--------------------- 1 file changed, 1 insertion(+), 21 deletions(-) diff --git a/.github/workflows/build-documentation.yml b/.github/workflows/build-documentation.yml index 851206dc1..68d5142c5 100644 --- a/.github/workflows/build-documentation.yml +++ b/.github/workflows/build-documentation.yml @@ -9,24 +9,8 @@ env: SIMULATION: native jobs: - #Checks for duplicate actions. Skips push actions if there is a matching or duplicate pull-request action. - checks-for-duplicates: - runs-on: ubuntu-latest - # Map a step output to a job output - outputs: - should_skip: ${{ steps.skip_check.outputs.should_skip }} - steps: - - id: skip_check - uses: fkirc/skip-duplicate-actions@master - with: - concurrent_skipping: 'same_content' - skip_after_successful_duplicate: 'true' - do_not_skip: '["pull_request", "workflow_dispatch", "schedule"]' build-docs: - #Continue if checks-for-duplicates found no duplicates. Always runs for pull-requests. - needs: checks-for-duplicates - if: ${{ needs.checks-for-duplicates.outputs.should_skip != 'true' }} name: cFE Documentation runs-on: ubuntu-18.04 @@ -72,8 +56,6 @@ jobs: build-usersguide: # Name the Job - needs: checks-for-duplicates - if: ${{ needs.checks-for-duplicates.outputs.should_skip != 'true' }} name: Users Guide # Set the type of machine to run on runs-on: ubuntu-18.04 @@ -156,8 +138,6 @@ jobs: build-osalguide: # Name the Job - needs: checks-for-duplicates - if: ${{ needs.checks-for-duplicates.outputs.should_skip != 'true' }} name: Osal Guide # Set the type of machine to run on runs-on: ubuntu-18.04 @@ -222,7 +202,7 @@ jobs: if: ${{ github.event_name == 'push' && contains(github.ref, 'main')}} run: | mkdir deploy - cd ./build/doc/osalguide/latex + cd ./build/doc/osalguide/apiguide/latex make > build.txt mv refman.pdf $GITHUB_WORKSPACE/deploy/OSAL_Users_Guide.pdf # Could add pandoc and convert to github markdown From 841587fb5a9279cdb1cab860a1aef8a1f140beb8 Mon Sep 17 00:00:00 2001 From: Ariel Adams <69638935+ArielSAdamsNASA@users.noreply.github.com> Date: Tue, 6 Jul 2021 11:39:47 -0500 Subject: [PATCH 08/12] Update build-documentation.yml --- .github/workflows/build-documentation.yml | 72 ++++++++++++++++------- 1 file changed, 51 insertions(+), 21 deletions(-) diff --git a/.github/workflows/build-documentation.yml b/.github/workflows/build-documentation.yml index 68d5142c5..d1ce225f2 100644 --- a/.github/workflows/build-documentation.yml +++ b/.github/workflows/build-documentation.yml @@ -9,8 +9,24 @@ env: SIMULATION: native jobs: + #Checks for duplicate actions. Skips push actions if there is a matching or duplicate pull-request action. + checks-for-duplicates: + runs-on: ubuntu-latest + # Map a step output to a job output + outputs: + should_skip: ${{ steps.skip_check.outputs.should_skip }} + steps: + - id: skip_check + uses: fkirc/skip-duplicate-actions@master + with: + concurrent_skipping: 'same_content' + skip_after_successful_duplicate: 'true' + do_not_skip: '["pull_request", "workflow_dispatch", "schedule"]' build-docs: + #Continue if checks-for-duplicates found no duplicates. Always runs for pull-requests. + needs: checks-for-duplicates + if: ${{ needs.checks-for-duplicates.outputs.should_skip != 'true' }} name: cFE Documentation runs-on: ubuntu-18.04 @@ -62,31 +78,37 @@ jobs: steps: # Checks out a copy of your repository on the ubuntu-latest machine - - name: Checkout code + - if: ${{ needs.checks-for-duplicates.outputs.should_skip != 'true' }} + name: Checkout code uses: actions/checkout@v2 with: submodules: true persist-credentials: false # Setup the build system - - name: Copy Files + - if: ${{ needs.checks-for-duplicates.outputs.should_skip != 'true' }} + name: Copy Files run: | cp ./cfe/cmake/Makefile.sample Makefile cp -r ./cfe/cmake/sample_defs sample_defs - # Setup the build system - - name: Make Prep + # Setup the build system + - if: ${{ needs.checks-for-duplicates.outputs.should_skip != 'true' }} + name: Make Prep run: make prep - - name: Install Dependencies + - if: ${{ needs.checks-for-duplicates.outputs.should_skip != 'true' }} + name: Install Dependencies run: sudo apt-get install doxygen graphviz -y - - name: Build Usersguide + - if: ${{ needs.checks-for-duplicates.outputs.should_skip != 'true' }} + name: Build Usersguide run: | make usersguide > make_usersguide_stdout.txt 2> make_usersguide_stderr.txt mv build/doc/warnings.log usersguide_warnings.log - - name: Archive Users Guide Build Logs + - if: ${{ needs.checks-for-duplicates.outputs.should_skip != 'true' }} + name: Archive Users Guide Build Logs uses: actions/upload-artifact@v2 with: name: Users Guide Artifacts @@ -95,15 +117,16 @@ jobs: make_usersguide_stderr.txt usersguide_warnings.log - - - name: Error Check + - if: ${{ needs.checks-for-duplicates.outputs.should_skip != 'true' }} + name: Error Check run: | if [[ -s make_usersguide_stderr.txt ]]; then cat make_usersguide_stderr.txt exit -1 fi - - name: Warning Check + - if: ${{ needs.checks-for-duplicates.outputs.should_skip != 'true' }} + name: Warning Check run: | if [[ -s usersguide_warnings.log ]]; then cat usersguide_warnings.log @@ -144,32 +167,37 @@ jobs: steps: # Checks out a copy of your repository on the ubuntu-latest machine - - name: Checkout code + - if: ${{ needs.checks-for-duplicates.outputs.should_skip != 'true' }} + name: Checkout code uses: actions/checkout@v2 with: submodules: true persist-credentials: false # Setup the build system - - name: Copy Files + - if: ${{ needs.checks-for-duplicates.outputs.should_skip != 'true' }} + name: Copy Files run: | cp ./cfe/cmake/Makefile.sample Makefile cp -r ./cfe/cmake/sample_defs sample_defs - # Setup the build system - - name: Make Prep + # Setup the build system + - if: ${{ needs.checks-for-duplicates.outputs.should_skip != 'true' }} + name: Make Prep run: make prep - - name: Install Dependencies + - if: ${{ needs.checks-for-duplicates.outputs.should_skip != 'true' }} + name: Install Dependencies run: sudo apt-get install doxygen graphviz -y - - name: Build OSAL Guide + - if: ${{ needs.checks-for-duplicates.outputs.should_skip != 'true' }} + name: Build OSAL Guide run: | make osalguide > make_osalguide_stdout.txt 2> make_osalguide_stderr.txt mv build/doc/osalguide/osal-apiguide-warnings.log osal-apiguide-warnings.log - - - name: Archive Osal Guide Build Logs + - if: ${{ needs.checks-for-duplicates.outputs.should_skip != 'true' }} + name: Archive Osal Guide Build Logs uses: actions/upload-artifact@v2 with: name: OSAL Guide Artifacts @@ -179,14 +207,16 @@ jobs: osal-apiguide-warnings.log - - name: Error Check + - if: ${{ needs.checks-for-duplicates.outputs.should_skip != 'true' }} + name: Error Check run: | if [[ -s make_osalguide_stderr.txt ]]; then cat make_osalguide_stderr.txt exit -1 fi - - name: Warning Check + - if: ${{ needs.checks-for-duplicates.outputs.should_skip != 'true' }} + name: Warning Check run: | if [[ -s osal-apiguide-warnings.log ]]; then cat osal-apiguide-warnings.log @@ -202,7 +232,7 @@ jobs: if: ${{ github.event_name == 'push' && contains(github.ref, 'main')}} run: | mkdir deploy - cd ./build/doc/osalguide/apiguide/latex + cd ./build/doc/osalguide/latex make > build.txt mv refman.pdf $GITHUB_WORKSPACE/deploy/OSAL_Users_Guide.pdf # Could add pandoc and convert to github markdown From 727dfa87b60ac05740a1c7d8b9bd7e92eed6bab3 Mon Sep 17 00:00:00 2001 From: "ariel.s.adams" Date: Tue, 6 Jul 2021 10:07:14 -0500 Subject: [PATCH 09/12] Fix #286, Documentation Duplicate Check --- .github/workflows/build-documentation.yml | 58 +++++++++++++---------- 1 file changed, 34 insertions(+), 24 deletions(-) diff --git a/.github/workflows/build-documentation.yml b/.github/workflows/build-documentation.yml index 851206dc1..d1ce225f2 100644 --- a/.github/workflows/build-documentation.yml +++ b/.github/workflows/build-documentation.yml @@ -72,39 +72,43 @@ jobs: build-usersguide: # Name the Job - needs: checks-for-duplicates - if: ${{ needs.checks-for-duplicates.outputs.should_skip != 'true' }} name: Users Guide # Set the type of machine to run on runs-on: ubuntu-18.04 steps: # Checks out a copy of your repository on the ubuntu-latest machine - - name: Checkout code + - if: ${{ needs.checks-for-duplicates.outputs.should_skip != 'true' }} + name: Checkout code uses: actions/checkout@v2 with: submodules: true persist-credentials: false # Setup the build system - - name: Copy Files + - if: ${{ needs.checks-for-duplicates.outputs.should_skip != 'true' }} + name: Copy Files run: | cp ./cfe/cmake/Makefile.sample Makefile cp -r ./cfe/cmake/sample_defs sample_defs - # Setup the build system - - name: Make Prep + # Setup the build system + - if: ${{ needs.checks-for-duplicates.outputs.should_skip != 'true' }} + name: Make Prep run: make prep - - name: Install Dependencies + - if: ${{ needs.checks-for-duplicates.outputs.should_skip != 'true' }} + name: Install Dependencies run: sudo apt-get install doxygen graphviz -y - - name: Build Usersguide + - if: ${{ needs.checks-for-duplicates.outputs.should_skip != 'true' }} + name: Build Usersguide run: | make usersguide > make_usersguide_stdout.txt 2> make_usersguide_stderr.txt mv build/doc/warnings.log usersguide_warnings.log - - name: Archive Users Guide Build Logs + - if: ${{ needs.checks-for-duplicates.outputs.should_skip != 'true' }} + name: Archive Users Guide Build Logs uses: actions/upload-artifact@v2 with: name: Users Guide Artifacts @@ -113,15 +117,16 @@ jobs: make_usersguide_stderr.txt usersguide_warnings.log - - - name: Error Check + - if: ${{ needs.checks-for-duplicates.outputs.should_skip != 'true' }} + name: Error Check run: | if [[ -s make_usersguide_stderr.txt ]]; then cat make_usersguide_stderr.txt exit -1 fi - - name: Warning Check + - if: ${{ needs.checks-for-duplicates.outputs.should_skip != 'true' }} + name: Warning Check run: | if [[ -s usersguide_warnings.log ]]; then cat usersguide_warnings.log @@ -156,40 +161,43 @@ jobs: build-osalguide: # Name the Job - needs: checks-for-duplicates - if: ${{ needs.checks-for-duplicates.outputs.should_skip != 'true' }} name: Osal Guide # Set the type of machine to run on runs-on: ubuntu-18.04 steps: # Checks out a copy of your repository on the ubuntu-latest machine - - name: Checkout code + - if: ${{ needs.checks-for-duplicates.outputs.should_skip != 'true' }} + name: Checkout code uses: actions/checkout@v2 with: submodules: true persist-credentials: false # Setup the build system - - name: Copy Files + - if: ${{ needs.checks-for-duplicates.outputs.should_skip != 'true' }} + name: Copy Files run: | cp ./cfe/cmake/Makefile.sample Makefile cp -r ./cfe/cmake/sample_defs sample_defs - # Setup the build system - - name: Make Prep + # Setup the build system + - if: ${{ needs.checks-for-duplicates.outputs.should_skip != 'true' }} + name: Make Prep run: make prep - - name: Install Dependencies + - if: ${{ needs.checks-for-duplicates.outputs.should_skip != 'true' }} + name: Install Dependencies run: sudo apt-get install doxygen graphviz -y - - name: Build OSAL Guide + - if: ${{ needs.checks-for-duplicates.outputs.should_skip != 'true' }} + name: Build OSAL Guide run: | make osalguide > make_osalguide_stdout.txt 2> make_osalguide_stderr.txt mv build/doc/osalguide/osal-apiguide-warnings.log osal-apiguide-warnings.log - - - name: Archive Osal Guide Build Logs + - if: ${{ needs.checks-for-duplicates.outputs.should_skip != 'true' }} + name: Archive Osal Guide Build Logs uses: actions/upload-artifact@v2 with: name: OSAL Guide Artifacts @@ -199,14 +207,16 @@ jobs: osal-apiguide-warnings.log - - name: Error Check + - if: ${{ needs.checks-for-duplicates.outputs.should_skip != 'true' }} + name: Error Check run: | if [[ -s make_osalguide_stderr.txt ]]; then cat make_osalguide_stderr.txt exit -1 fi - - name: Warning Check + - if: ${{ needs.checks-for-duplicates.outputs.should_skip != 'true' }} + name: Warning Check run: | if [[ -s osal-apiguide-warnings.log ]]; then cat osal-apiguide-warnings.log From 73d541bcde65e921d3cf9c1752a5a77b76ce0936 Mon Sep 17 00:00:00 2001 From: Ariel Adams <69638935+ArielSAdamsNASA@users.noreply.github.com> Date: Wed, 7 Jul 2021 08:17:34 -0500 Subject: [PATCH 10/12] Create index.html --- index.html | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 index.html diff --git a/index.html b/index.html new file mode 100644 index 000000000..126a8007d --- /dev/null +++ b/index.html @@ -0,0 +1,7 @@ + + + +

Hello World

+

I'm hosted with GitHub Pages.

+ + From 3a74b3b914daf50e9d72ec873c59cec45ece45be Mon Sep 17 00:00:00 2001 From: "ariel.s.adams" Date: Tue, 6 Jul 2021 10:07:14 -0500 Subject: [PATCH 11/12] Fix #286, Documentation Duplicate Check --- .github/workflows/build-documentation.yml | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/.github/workflows/build-documentation.yml b/.github/workflows/build-documentation.yml index 851206dc1..f4a3cd50d 100644 --- a/.github/workflows/build-documentation.yml +++ b/.github/workflows/build-documentation.yml @@ -128,6 +128,14 @@ jobs: exit -1 fi + pdf-usersguide: + # Name the Job + name: PDF Users Guide + # Set the type of machine to run on + runs-on: ubuntu-18.04 + + steps: + - name: PDF generation installs if: ${{ github.event_name == 'push' && contains(github.ref, 'main')}} run: | @@ -153,7 +161,7 @@ jobs: FOLDER: deploy CLEAN: false SINGLE_COMMIT: true - + build-osalguide: # Name the Job needs: checks-for-duplicates @@ -212,7 +220,14 @@ jobs: cat osal-apiguide-warnings.log exit -1 fi + + pdf-osalguide: + # Name the Job + name: PDF Osal Guide + # Set the type of machine to run on + runs-on: ubuntu-18.04 + steps: - name: PDF generation installs if: ${{ github.event_name == 'push' && contains(github.ref, 'main')}} run: | From 220a42bc6234176b781fb2b8a3f0350ded422b1b Mon Sep 17 00:00:00 2001 From: "ariel.s.adams" Date: Tue, 6 Jul 2021 10:07:14 -0500 Subject: [PATCH 12/12] Fix #286, Documentation Duplicate Check --- .github/workflows/build-documentation.yml | 71 ++++++++++++++--------- 1 file changed, 45 insertions(+), 26 deletions(-) diff --git a/.github/workflows/build-documentation.yml b/.github/workflows/build-documentation.yml index 851206dc1..58b96b4ae 100644 --- a/.github/workflows/build-documentation.yml +++ b/.github/workflows/build-documentation.yml @@ -128,32 +128,6 @@ jobs: exit -1 fi - - name: PDF generation installs - if: ${{ github.event_name == 'push' && contains(github.ref, 'main')}} - run: | - sudo apt-get install texlive-latex-base texlive-fonts-recommended texlive-fonts-extra texlive-latex-extra - - - name: PDF generation - if: ${{ github.event_name == 'push' && contains(github.ref, 'main')}} - run: | - set -x - mkdir deploy - cd ./build/doc/users_guide/latex - make > build.txt - mv refman.pdf $GITHUB_WORKSPACE/deploy/cFE_Users_Guide.pdf - # Could add pandoc and convert to github markdown - # pandoc CFE_Users_Guide.pdf -t gfm - - - name: Deploy - if: ${{ github.event_name == 'push' && contains(github.ref, 'main')}} - uses: JamesIves/github-pages-deploy-action@3.7.1 - with: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - BRANCH: gh-pages - FOLDER: deploy - CLEAN: false - SINGLE_COMMIT: true - build-osalguide: # Name the Job needs: checks-for-duplicates @@ -212,7 +186,52 @@ jobs: cat osal-apiguide-warnings.log exit -1 fi + + + pdf-usersguide: + needs: build-usersguide + # Name the Job + name: PDF Users Guide + # Set the type of machine to run on + runs-on: ubuntu-18.04 + + steps: + + - name: PDF generation installs + if: ${{ github.event_name == 'push' && contains(github.ref, 'main')}} + run: | + sudo apt-get install texlive-latex-base texlive-fonts-recommended texlive-fonts-extra texlive-latex-extra + + - name: PDF generation + if: ${{ github.event_name == 'push' && contains(github.ref, 'main')}} + run: | + set -x + mkdir deploy + cd ./build/doc/users_guide/latex + make > build.txt + mv refman.pdf $GITHUB_WORKSPACE/deploy/cFE_Users_Guide.pdf + # Could add pandoc and convert to github markdown + # pandoc CFE_Users_Guide.pdf -t gfm + - name: Deploy + if: ${{ github.event_name == 'push' && contains(github.ref, 'main')}} + uses: JamesIves/github-pages-deploy-action@3.7.1 + with: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + BRANCH: gh-pages + FOLDER: deploy + CLEAN: false + SINGLE_COMMIT: true + + + pdf-osalguide: + needs: build-osalguide + # Name the Job + name: PDF Osal Guide + # Set the type of machine to run on + runs-on: ubuntu-18.04 + + steps: - name: PDF generation installs if: ${{ github.event_name == 'push' && contains(github.ref, 'main')}} run: |