Merge c8c7f03 into c243119

ReliaQualAssociates · Dec 30, 2020 · 993b8b8 · 993b8b8
2 parents c243119 + c8c7f03
commit 993b8b8
Show file tree

Hide file tree

Showing 48 changed files with 1,519 additions and 933 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -14,7 +14,7 @@ commands:
           name: Install apt packages
           command: |
             sudo apt -qq update
-            sudo apt install--no-install-recommends -y \
+            sudo apt install --no-install-recommends -y \
               libgirepository1.0-dev \
               gir1.2-gtk-3.0 \
               python3-gi \

diff --git a/.gitcommittemplate.txt b/.gitcommittemplate.txt
@@ -1,12 +1,12 @@
 # ----------- This is 50 characters ----------> |
 # Remember to format your commit message thusly...
 #
-# <type>(<primary scope::secondary scope>): <subject>
+# <type>([optional scope]): <subject>
 # Try to keep the subject line <=50 characters
 # <BLANK LINE>
-# <body>
+# [optional body]
 # <BLANK LINE>
-# <footer>
+# [optional footer]
 #
 # <type> is one of:
 #
@@ -17,42 +17,17 @@
 #    * docs: documentation only change.
 #    * chore: changes to the build process or auxiliary tools.
 #
-# <primary scope> & <secondary scope> is one of:
-#
-#    * Revision or Rev
-#    * Requirement or Req
-#    * Function or Func
-#    * Hardware or HW
-#    * Validation or Val
-#    * Options or Opt
-#    * Preferences or Pref
-#    * Export/Import or Exim
-#    * Utilities or Util
-#    * Configuration or Conf
-#    * Logger or Log
-#    * Database or DB
-#    * GUI
-#    * Usage
-#    * FailureDefinition or FailDef
-#    * Stakeholder or Stake
-#    * Allocation or Alloc
-#    * HazOps
-#    * SimilarItem or SIA
-#    * MIL217
-#    * FMEA
-#    * PoF
-#
-# You may use an asterick (*) if the changes affect multiple primary
-# scopes or the change is docs or chore type.
+# Add an exclamation point (!) before the colon (:) if this is a breaking
+# change.  This should ONLY happen on fix types.
 #
 # <subject> should complete the following sentence:
 #
 #     If applied, this commit will...
 #
-# <body> is a multi-line description of the changes.  Use bulleted lists
-# (-, *, etc.)to make this easier to read.
+# [optional body] is a multi-line description of the changes.  Use bulleted
+# lists (-, *, etc.)to make this easier to read.
 #
-# <footer> is the place to list all the GitHub issues (if any) the
+# [optional footer] is the place to list all the GitHub issues (if any) the
 # commit closes.  These should be listed in one of the following formats:
 #
 #     Close: #<Issue ID>

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,42 @@
+## Pull Request Checklist
+
+- [ ] Use cases / requirements have been documented in REQUIREMENTS.md.
+  - [ ] Tests have been added or updated to verify compliance with a
+   requirement.
+  - [ ] Test titles are adequately descriptive.
+  - [ ] Tests capture key use cases.
+  - [ ] Enough edge cases covered for comfort.
+  - [ ] Code coverage has not decreased.
+- [ ] Code is following code style guidelines.
+  - [ ] Followed in new code.
+  - [ ] Corrected in existing code whenever possible.
+  - [ ] Spelling and English grammar errors have been eliminated.
+  - [ ] Attribute and variable names make sense.
+  - [ ] Have you updated or created stub files.
+- [ ] New code is readable.
+  - [ ] Execute 'make maintain' before committing changes and fix any issues.
+  - [ ] Code is not overly complicated; refactor if it is.
+  - [ ] Debugging, including print(), statements have been removed.
+- [ ] Problem areas outside the scope of this PR have an # ISSUE: comment
+ decorating the code block.  These # ISSUE: comments are automatically
+  converted to issues on successful merge.  Alternatively, you can manually
+   raise an issue for each problem area you identify.
+  - [ ] TODO and FIXME statements have been have been converted to # ISSUE
+ : comments or removed in their entirety.
+  - [ ] \# ISSUE: comments have been removed for those issues this PR
+   addresses.
+- [ ] All PR checks pass.
+  - [ ] Execute 'make format', 'make stylecheck', 'make typecheck', and 'make
+   lint' before committing changes and fix any issues.
+  - [ ] Failing static checks are only applicable to code outside the scope of
+   this PR.
+
+## Does this PR introduce a breaking change?
+- [ ] Yes
+- [ ] No
+
+<!-- If yes, describe the impact and migration path below. -->
+
+## Other information
+<!-- Provide any other information that is import to this PR such as
+screenshots if this impacts the GUI. -->
diff --git a/.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md
diff --git a/.github/workflows/chores.yml b/.github/workflows/chores.yml
@@ -8,9 +8,13 @@ on:
 
 jobs:
   good_pr_title:
-    name: Ensure Semantic PR Title
+    name: Ensure Conventional PR Title
     runs-on: ubuntu-latest
     steps:
-      - uses: aslafy-z/conventional-pr-title-action@master
+      - name: Ensure PR title follows conventional commits specification
+        uses: aslafy-z/conventional-pr-title-action@master
+        with:
+          success-state: Conventional commits compliant title detected.
+          failure-state: Pull request title is not conventional commits compliant!
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/create-issues.yml b/.github/workflows/create-issues.yml
@@ -20,7 +20,7 @@ jobs:
           BEFORE: ${{ github.event.before }}
           SHA: ${{ github.sha }}
           TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          LABEL: "#// TODO:"
-          COMMENT_MARKER: "#//"
+          LABEL: "# ISSUE:"
+          COMMENT_MARKER: "# //"
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/version.yml b/.github/workflows/version.yml
@@ -1,4 +1,4 @@
-name: Bump Version
+name: Bump and Tag
 
 on:
   pull_request:
@@ -7,47 +7,48 @@ on:
 
 jobs:
   bump_semantic_version:
-    name: Bump Semantic Version
+    name: Bump Semantic Version & Tag
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
         uses: actions/checkout@v2
         with:
           fetch-depth: 0
-      - name: Determine next implied version
-        id: nextversion
-        uses: paulhatch/semantic-version@v3.2
-        with:
-          branch: "develop"
-          format: "${major}.${minor}.${patch}-rc${increment}"
-          short_tags: false
-      - name: Output new version
+      - name: Get PR branch information
+        id: branchinfo
+        shell: bash
         run: |
-          echo "Major: ${{ steps.nextversion.outputs.major }}"
-          echo "Minor: ${{ steps.nextversion.outputs.minor }}"
-          echo "Patch: ${{ steps.nextversion.outputs.patch }}"
-          echo "Increment: ${{ steps.nextversion.outputs.increment }}"
-          echo "Version: ${{ steps.nextversion.outputs.version }}"
-          echo "Version Tag: ${{ steps.nextversion.outputs.version_tag }}"
-          echo "Changed: ${{ steps.nextversion.outputs.changed }}"
-      - name: Bump release version
+          echo "##[set-output name=pr;]$(echo ${GITHUB_REF#refs/pull/})"
+          echo "##[set-output name=head;]$(echo ${GITHUB_HEAD_REF})"
+          echo "##[set-output name=base;]$(echo ${GITHUB_BASE_REF})"
+          echo "##[set-output name=tag;]$(git describe --tags --abbrev=0 origin/${GITHUB_HEAD_REF})"
+          echo "##[set-output name=version;]$(git describe --tags --abbrev=0 origin/${GITHUB_HEAD_REF} | sed 's/v//')"
+      - name: Print PR branch information
+        run: |
+          echo "PR: ${{ steps.branchinfo.outputs.pr }}"
+          echo "Head: ${{ steps.branchinfo.outputs.head }}"
+          echo "Base: ${{ steps.branchinfo.outputs.base }}"
+          echo "Tag: ${{ steps.branchinfo.outputs.tag }}"
+          echo "Version: ${{ steps.branchinfo.outputs.version }}"
+      - name: Determine next release version
         id: bumpversion
         uses: christian-draeger/increment-semantic-version@1.0.2
         with:
-          current-version: "${{ steps.nextversion.outputs.version }}"
+          current-version: "${{ steps.branchinfo.outputs.version }}"
           version-fragment: "rc"
-      - name: Output next version
+      - name: Output next release version
         run: |
           echo "Next Version: ${{ steps.bumpversion.outputs.next-version }}"
-      - name: Version release
-        id: nextversion2
-        uses: zwaldowski/semver-release-action@v2
-        with:
-          dry_run: true
-          bump: prerelease
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-      - name: Output next version 2
+      - name: Bump release version
+        id: anothrnick
+        uses: anothrNick/github-tag-action@1.26.0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          WITH_V: true
+          INITIAL_VERSION: "${{ steps.branchinfo.outputs.version }}"
+          DRY_RUN: true
+      - name: Output anothrNick version
         run: |
-          echo "Next Version 2: ${{ steps.nextversion2.version }}"
-          echo "Optimistic Version 2: ${{ steps.nextversion2.version_optimistic }}"
-          echo "Version Tag 2: ${{ steps.nextversion2.version_tag }}"
+          echo "New Tag: ${{ steps.anothrnick.outputs.new_tag }}"
+          echo "Tag: ${{ steps.anothrnick.outputs.tag }}"
+          echo "Part: ${{ steps.anothrnick.outputs.part }}"
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,9 +1,10 @@
 repos:
     - repo: https://github.com/pre-commit/pre-commit-hooks
-      rev: v3.2.0
+      rev: v3.4.0
       hooks:
           - id: check-docstring-first
           - id: check-merge-conflict
+          - id: check-toml
           - id: debug-statements
           - id: end-of-file-fixer
           - id: no-commit-to-branch