Merge pull request #16 from qingfengxia/dev

fix issue 12 13 and doc tweaks

Author: qingfengxia

.github/pull_request_template.md

@@ -0,0 +1,21 @@
+<!--
+Thank you very much for putting in this PR!
+
+PR is usually related with issue (github issue) or feature (slack, issue), please refer the link to issue and feature discussion. 
+. If this PR is about tiny fix like spelling, document enhancement, please describe the fix in more details here. 
+
+PR needs to reviewed before merged, please let the right people know.
+Currently available team members to review and merge PR are:
+- Qingfeng Xia
+- Andrew Davis
+- John Nonweiler
+
+-->
+
+Checklist
+- [ ] Source is rebased on latest `upstream main` so is mergeable automatically or easily merged even with confliction.
+- [ ] Title of this PR is meaningful: e.g. "fix issue #8 geomPipeline.py -o does not work", not "fix geomPipeline.py"
+- [ ] Commit message is meaningful:  `git push origin +your_branch` to squash some tiny fixes for CI failures
+- [ ] Give the maintainer the legal rights to change the open source license in the future (see wiki/Contribution.md) for details
+
+

.github/workflows/conda-ci.yml

@@ -77,9 +77,12 @@ jobs:
         make 2>&1 | tee clang_tidy_build_results.log
         make package
         ls *.${{ matrix.package_suffix }}
+        if hash dpkg 2>/dev/null; then  dpkg -i *.${{ matrix.package_suffix }}; fi
+        if hash rpm 2>/dev/null; then  rpm -Uhv *.${{ matrix.package_suffix }}; fi
         # copy the package to $GITHUB_WORKSPACE, pointer to host path, is not possible, while upload from ${{ github.workspace }} is fine
         mv *.${{ matrix.package_suffix }} ${{ env.PROJECT_NAME }}-${{ env.PROJECT_VERSION }}_${{ matrix.os }}.${{ matrix.package_suffix }}
 
+
     ###################  testing ##########################
     - name: Run unit tests
       working-directory: ${{ github.workspace }}/build

.github/workflows/docker-ci.yml

@@ -26,18 +26,18 @@ jobs:
               compiler: gcc
               compilerpp: g++
               package_suffix: 'deb'
-            - os: 'macos-latest'
-              compiler: gcc
-              compilerpp: g++
-              package_suffix: 'dmg'
+            # - os: 'macos-latest'
+            #   compiler: gcc
+            #   compilerpp: g++
+            #   package_suffix: 'dmg'
     steps:
     - uses: actions/checkout@v2
 
     - name: Install Dependencies ( Ubuntu 20.04)
       run: |
            sudo apt-get update
            #sudo apt-get upgrade
-           sudo apt-get install -y  g++ cmake clang cppcheck similarity-tester flawfinder
+           sudo apt-get install -y  g++ cmake clang cppcheck similarity-tester flawfinder p7zip-full openssl
            sudo apt-get install -y lcov htmldoc poppler-utils graphviz doxygen
            sudo apt-get install -y libtbb*-dev libocct-*-dev occt-misc python3-dev python3-pybind11 libboost-dev freecad
            sudo apt-get install -y libx11-dev libxmu-dev libxi-dev
@@ -54,6 +54,16 @@ jobs:
            sudo apt-get install -y  libx11-dev libxmu-dev libxi-dev
       if: matrix.os == 'ubuntu-18.04'
 
+    - name: zip source code for release
+      run: |
+        cd ..
+        ls
+        7z a -r ${{ env.PROJECT_NAME }}.zip ${{ env.PROJECT_NAME }}
+        mv ${{ env.PROJECT_NAME }}.zip ${{ github.workspace }}/
+        cd ${{ github.workspace }}
+        sha256sum ${{ env.PROJECT_NAME }}.zip | awk '{ print $1; }' > ${{ github.workspace }}/${{ env.PROJECT_NAME }}.zip.sha256.txt
+      if:  matrix.os == 'ubuntu-20.04'
+    
     - name: Compile on Linux (debug)
       # env:
       #         CC: ${{ matrix.compiler }}
@@ -64,7 +74,6 @@ jobs:
         cd build
         cmake  -DCODE_COVERAGE=ON -DPython_EXECUTABLE=$(which python3) -DPPP_VERSION_NAME=${{ env.PROJECT_VERSION }} ..  -Wno-dev
         make 2>&1 | tee clang_tidy_build_results.log
-        # packup source code into zip and show in release : https://github.com/ukaea/parallel-preprocessor/archive/dev.zip
       if:  matrix.os == 'ubuntu-20.04'
 
     - name: Compile on Linux (release)
@@ -141,6 +150,32 @@ jobs:
         overwrite: true
         prerelease: true
       if: github.ref == 'refs/heads/main'  # only upload package on main branch, not PR, forks, which has no write access
+
+    ###################  zip and upload source code zip ##########################
+    # those release asset filename endpoint (not necessarily created before this upload)
+    - name: Upload source code to release
+      uses: svenstaro/upload-release-action@v2
+      with:
+        repo_token: ${{ secrets.GITHUB_TOKEN }}
+        file: ${{ github.workspace }}/${{ env.PROJECT_NAME }}.zip
+        asset_name: ${{ env.PROJECT_NAME }}.zip
+        tag: dev
+        overwrite: true
+        prerelease: true
+      if: github.ref == 'refs/heads/main' && matrix.os == 'ubuntu-20.04'
+
+    - name: Upload source code checksum
+      uses: svenstaro/upload-release-action@v2
+      with:
+        repo_token: ${{ secrets.GITHUB_TOKEN }}
+        file: ${{ github.workspace }}/${{ env.PROJECT_NAME }}.zip.sha256.txt
+        asset_name: ${{ env.PROJECT_NAME }}.zip.sha256.txt
+        tag: dev
+        overwrite: true
+        prerelease: true
+      if: github.ref == 'refs/heads/main' && matrix.os == 'ubuntu-20.04'
+      # only upload package on main branch, not PR, forks, which has no write access
+      # https://github.com/ukaea/parallel-preprocessor/releases/download/dev/parallel-preprocessor.zip
 
     ########################################## only for Ubuntu debug release ############################################
     - name: Run Cpp Check Flawfinder  Sim C++ ( Ubuntu GCC Dev/Master )
@@ -191,6 +226,7 @@ jobs:
       if: matrix.os == 'ubuntu-20.04' && ( github.ref == 'refs/heads/dev' || github.ref == 'refs/heads/main' )
 
     - name: Build Website Files ( Ubuntu GCC Dev/Master )
+      working-directory: ${{ github.workspace }}
       run: |
           python scripts/site_generation.py build/clang_tidy_build_results.log build/flawfinder.log build/sim_cpp.log
           git add -f site/*.html
@@ -203,4 +239,4 @@ jobs:
         github_token: ${{ secrets.GITHUB_TOKEN }}
         branch: gh-pages
         force: true
-      if: matrix.os == 'ubuntu-20.04' && ( github.ref == 'refs/heads/dev' || github.ref == 'refs/heads/main' )
+      if: matrix.os == 'ubuntu-20.04' && ( github.ref == 'refs/heads/dev' || github.ref == 'refs/heads/main' )

.github/workflows/github-ci.yml

@@ -1,11 +1,12 @@
-#this file should not go publically
 
 .vscode/*
 build/*
+build-bionic/*
 build-focal/*
 vcbuild/*
 condabuild/*
 
+
 third-party/*
 bin/*
 lib/*
@@ -19,6 +20,7 @@ incomplete_code/*
 
 */__pycache__/*
 *.so
+*.pyc
 
 
 Web/*