#220: copy workflows from the template-repository (#342)

* #220: copy workflows from the template-repository

* #220: exclude doc directory from the find-trailing-whitespace workflow action

* #220: remove trailing whitespaces in 2 files

* #220: remove trailing whitespaces from 2 github actions yaml files

Author: tlamonthezie

.github/workflows/acceptance-tests.yml

@@ -26,7 +26,7 @@ jobs:
       - name: Install packages
         run: |
           apt-get update && apt-get upgrade -y
-          apt-get install -y git xvfb 
+          apt-get install -y git xvfb
 
       - name: Install requirements
         run: |
@@ -77,7 +77,7 @@ jobs:
       - name: Install packages
         run: |
           apt-get update && apt-get upgrade -y
-          apt-get install -y git xvfb 
+          apt-get install -y git xvfb
 
       - name: Install requirements
         run: |

.github/workflows/action-git-diff-check.yml

@@ -0,0 +1,21 @@
+name: PR checks (git --check)
+
+on: pull_request
+
+jobs:
+  check:
+    name: Run git check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+          ref: ${{ github.event.pull_request.head.sha }}
+      - name: Fetch base_ref HEAD
+        run: git fetch --depth=1 origin +refs/heads/${{github.base_ref}}:refs/remotes/origin/${{github.base_ref}}
+      - name: Display base sha
+        shell: bash
+        run: echo "${{ github.event.pull_request.base.sha }}"
+      - uses: joel-coffman/action-git-diff-check@0.1
+        with:
+          revision: ${{ github.event.pull_request.base.sha }}

.github/workflows/check-commit-format.yml

@@ -0,0 +1,21 @@
+name: PR checks (commit formatting)
+
+on: pull_request
+
+jobs:
+  check:
+    name: Check commit message format
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+          ref: ${{ github.event.pull_request.head.sha }}
+      - name: Fetch base_ref HEAD
+        run: git fetch origin +refs/heads/${{github.base_ref}}:refs/remotes/origin/${{github.base_ref}}
+      - name: Display base sha
+        shell: bash
+        run: echo "${{ github.event.pull_request.base.sha }}"
+      - uses: DARMA-tasking/check-commit-format@master
+        with:
+          revision: ${{ github.event.pull_request.base.sha }}

.github/workflows/check-pr-fixes-issue.yml

@@ -0,0 +1,16 @@
+name: PR checks (PR description format)
+
+on:
+  pull_request:
+    types: [opened, edited, reopened, synchronize]
+
+jobs:
+  check:
+    name: Check PR description format
+    runs-on: ubuntu-latest
+    steps:
+      - uses: DARMA-tasking/check-pr-fixes-issue@master
+        with:
+          pr_branch: ${{ github.head_ref }}
+          pr_title: ${{ github.event.pull_request.title }}
+          pr_description: ${{ github.event.pull_request.body }}

.github/workflows/find-trailing-whitespace.yml

@@ -0,0 +1,13 @@
+name: PR checks (trailing whitespace)
+
+on: pull_request
+
+jobs:
+  check:
+    name: Find Trailing Whitespace
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: DARMA-tasking/find-trailing-whitespace@master
+        with:
+          exclude: "doc" # ; separated path to exclude

.github/workflows/find-unsigned-commits.yml

@@ -0,0 +1,15 @@
+name: PR checks (unsigned commits)
+
+on:
+  pull_request
+
+jobs:
+  check:
+    name: Check if there are any unsigned commits
+    runs-on: ubuntu-latest
+    steps:
+      - uses: DARMA-tasking/find-unsigned-commits@master
+        with:
+          repo_owner: ${{ github.event.repository.owner.login }}
+          repo_name: ${{ github.event.repository.name }}
+          pr_number: ${{ github.event.pull_request.number }}

.github/workflows/unit-tests.yml

@@ -23,7 +23,7 @@ jobs:
       - name: Install packages
         run: |
           sudo apt-get update && sudo apt-get upgrade -y
-          sudo apt-get install -y git xvfb 
+          sudo apt-get install -y git xvfb
 
       - name: Python Setup
         uses: actions/setup-python@v2

README.md

@@ -23,7 +23,7 @@ Make sure you have all required Pyhon packages installed with:
 pip install -r requirements-3.8.txt
 ```
 
-Requirements are divided into `LBAF dependencies` and `LBAF testing`. 
+Requirements are divided into `LBAF dependencies` and `LBAF testing`.
 
 `LBAF dependencies` are needed in order to LBAF to work.
 
@@ -88,7 +88,7 @@ python JSON_data_files_validator.py --dir_path=<project-path>/data/8color-4node
 
 # Optionally one could pass --file_prefix and/or --file_suffix
 # When one passes files with given prefix/suffix or both will be validated
-# When no prefix and suffix will be given validator will find most common prefix and suffix in the directory 
+# When no prefix and suffix will be given validator will find most common prefix and suffix in the directory
 # and will use them for validation process
 python JSON_data_files_validator.py --dir_path=../../data/8color-4node --file_prefix=data --file_suffix=json
 ```
@@ -109,8 +109,8 @@ VT data Extractor is located in:
 * `input_data_dir`: str - path to dir with files to extract e.g. `"../data/<dir-with-files>"`
 * `output_data_dir`: str - path to dir where files should be saved e.g. `"../output"` (will be created when doesn't exist)
 * `phases_to_extract`: list - list of phases `[int or str]` e.g. `[0, 1, "2-4"]` will extract phases `[0, 1, 2, 3, 4]`
-* `file_prefix`: str - data file prefix e.g. if filename is `stats.0.json`, then prefix should be set to "stats" 
-* `file_suffix`: str - data file suffix e.g. if filename is `stats.0.json`, then suffix should be set to "json" 
+* `file_prefix`: str - data file prefix e.g. if filename is `stats.0.json`, then prefix should be set to "stats"
+* `file_suffix`: str - data file suffix e.g. if filename is `stats.0.json`, then suffix should be set to "json"
 * `compressed`: bool - when True, brotli must be imported and then output data will be compressed
 * `schema_type`: str - should be `"LBDatafile"` or `"LBStatsfile"` depends on input data. Only `"LBStatsfile"` is supported
 * `check_schema`: bool - when True, validates schema (more time-consuming)

src/lbaf/IO/lbsMeshBasedVisualizer.py

@@ -62,7 +62,7 @@ def __init__(
                 self.__logger.error(
                     f"Inconsistent quantity of interest maximum: {rank_qoi_max}")
                 raise SystemExit(1)
-        
+
         # Make sure that Phase instances were passed
         if not all([isinstance(p, Phase) for p in phases]):
             self.__logger.error(
@@ -103,7 +103,7 @@ def __init__(
 
         # Compute discrete or pseudo-continuous object QOI range
         self.__object_qoi_range = self.compute_object_qoi_range(object_qoi)
-        
+
         # Assemble file and path names from constructor parameters
         self.__rank_file_name = f"{output_file_stem}_rank_view.e"
         self.__object_file_name = f"{output_file_stem}_object_view"
@@ -373,7 +373,7 @@ def create_object_mesh(self, phase: Phase, object_mapping: set):
                 b_arr.SetTuple1(point_index, m)
                 if l_arr:
                     l_arr.SetTuple1(point_index, o.get_load())
-                
+
                 # Update sent volumes
                 for k, v in o.get_sent().items():
                     sent_volumes.append((point_index, k, v))
@@ -442,7 +442,7 @@ def create_color_transfer_function(attribute_range, scheme=None):
             ctf.IndexedLookupOn()
             ctf.SetNumberOfIndexedColors(n_colors)
             for i, v in enumerate(attribute_range):
-                ctf.SetAnnotation(v, f"{v}") 
+                ctf.SetAnnotation(v, f"{v}")
                 ctf.SetIndexedColorRGBA(i, plt.cm.get_cmap("tab20")(i))
             ctf.Build()
             return ctf