Merge pull request #143 from TIBCOSoftware/feature/static-tools

feat(cicd): introduction of static tools
TIBCOSoftware · Jan 10, 2022 · 854601e · 854601e
2 parents fd238dd + f0ccc16
commit 854601e
Show file tree

Hide file tree

Showing 12 changed files with 5,671 additions and 12 deletions.
diff --git a/.commit-template b/.commit-template
@@ -0,0 +1,44 @@
+
+# We use conventional commit style commit messages for automated changelog building.
+# https://www.conventionalcommits.org/en/v1.0.0/
+#
+# Please use the following guidelines to format all your commit
+# messages:
+#
+#     <type>(<scope>): <subject>
+#     <BLANK LINE>
+#     <body>
+#     <BLANK LINE>
+#     <footer>
+#
+# Please note that:
+#  - The HEADER is a single line of max. 50 characters that
+#    contains a succinct description of the change. It contains a
+#    type, an optional scope, and a subject
+#       + <type> describes the kind of change that this commit is
+#                providing. Allowed types are:
+#             * feat (feature)
+#             * fix (bug fix)
+#             * docs (documentation)
+#             * style (formatting, missing semicolons, …)
+#             * refactor
+#             * test (when adding missing tests)
+#             * chore (maintain)
+#       + <scope> can be anything specifying the place of the commit
+#                 change. Allowed types are:
+#             * cicd
+#             * infra
+#             * api
+#             * general
+#       + <subject> is a very short description of the change, in
+#                   the following format:
+#             * imperative, present tense: “change” not
+#               “changed”/“changes”
+#             * no capitalized first letter
+#             * no dot (.) at the end
+#  - The BODY should include the motivation for the change and
+#    contrast this with previous behavior and must be phrased in
+#    imperative present tense
+#  - The FOOTER should contain any information about Breaking
+#    Changes and is also the place to reference GitHub issues that
+#    this commit closes
diff --git a/.github/linters/.jscpd.json b/.github/linters/.jscpd.json
@@ -0,0 +1,8 @@
+{
+    "reporters": ["html", "markdown" ],
+    "ignore": [
+        "**/.github/workflows/build.yaml",
+        "**/.github/workflows/deploy.yaml"
+    ],
+    "threshold": 3
+}
diff --git a/.github/linters/.markdown-lint.yml b/.github/linters/.markdown-lint.yml
@@ -0,0 +1,7 @@
+---
+MD024:
+  # Allow changelog to reuse headings
+  siblings_only: true
+MD013:
+  # Allow longer lines
+  line_length: 120
diff --git a/.github/linters/.stylelintrc.yaml b/.github/linters/.stylelintrc.yaml
@@ -0,0 +1,2 @@
+extends: stylelint-config-sass-guidelines
+
diff --git a/.github/linters/.yaml-lint.yml b/.github/linters/.yaml-lint.yml
@@ -0,0 +1,6 @@
+rules:
+  line-length:
+    max: 140
+    ignore: |
+      "**/.github/workflows/build.yaml"
+
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -0,0 +1,12 @@
+# Story
+
+Describe the story of the problem or new feature work.
+
+## Changes
+
+1. Enumerate changes
+2. Enumerate changes
+
+## Tests
+
+Describe the tests that were performed.
diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml
@@ -0,0 +1,43 @@
+---
+name: Static Analysis
+
+#
+# Documentation:
+# https://help.github.com/en/articles/workflow-syntax-for-github-actions
+
+#############################
+# Start the job on all push #
+#############################
+on: [push]
+
+jobs:
+  static-analysis:
+      # Name the Job
+      name: Lint Code Base
+      # Set the agent to run on
+      runs-on: ubuntu-latest
+
+      steps:
+        - name: Checkout Code
+          uses: actions/checkout@v2
+          with:
+            # Full git history is needed to get a proper list of changed files within `super-linter`
+            fetch-depth: 0
+
+        - name: Lint Code Base
+          uses: github/super-linter@v4
+          env:
+            VALIDATE_ALL_CODEBASE: false
+            DEFAULT_BRANCH: master
+            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+            FILTER_REGEX_EXCLUDE: 
+            # FILTER_REGEX_INCLUDE: .*src/.*
+            # Prefer typescript
+            VALIDATE_JAVASCRIPT_ES: false
+            VALIDATE_JAVASCRIPT_STANDARD: false
+            # Seems to not match our linter ... prefer the ES version
+            VALIDATE_TYPESCRIPT_STANDARD: false
+            # Too many errors in the project
+            VALIDATE_HTML: false
+            VALIDATE_CLOUDFORMATION: false
+            CSS_FILE_NAME: .stylelintrc.yaml
diff --git a/.versionrc.json b/.versionrc.json
@@ -0,0 +1,44 @@
+{
+  "types": [
+    {
+      "type": "feat",
+      "section": "Features"
+    },
+    {
+      "type": "fix",
+      "section": "Bug Fixes"
+    },
+    {
+      "type": "chore",
+      "hidden": true
+    },
+    {
+      "type": "docs",
+      "hidden": true
+    },
+    {
+      "type": "style",
+      "hidden": true
+    },
+    {
+      "type": "refactor",
+      "hidden": true
+    },
+    {
+      "type": "perf",
+      "hidden": true
+    },
+    {
+      "type": "test",
+      "hidden": true
+    }
+  ],
+  "commitUrlFormat": "https://github.com/TIBCOSoftware/labs-air/commits/{{hash}}",
+  "compareUrlFormat": "https://github.com/TIBCOSoftware/labs-air/compare/{{previousTag}}...{{currentTag}}",
+  "bumpFiles": [
+    {
+      "filename": "package.json",
+      "type": "json"
+    }
+  ]
+}
diff --git a/README.md b/README.md
@@ -1,27 +1,30 @@
 # TIBCO LABS™ Project AIR
 
-Link to full documentation Site: https://tibcosoftware.github.io/labs-air/
+Link to full documentation Site: <https://tibcosoftware.github.io/labs-air/>
+
+![Static Analysis](https://github.com/TIBCOSoftware/labs-air/workflows/Static%20Analysis/badge.svg)
 
 ## other Project AIR GitHub Repositories
-TIBCO LABS Project AIR consist of multiple Repos <a href="https://github.com/orgs/TIBCOSoftware/repositories?language=&q=air&sort=&type=" target="_blank">full Query here</a>.<br>
+
+TIBCO LABS Project AIR consist of multiple Repos [full Query here](https://github.com/orgs/TIBCOSoftware/repositories?language=&q=air&sort=&type=).
 Here a quick Introduction ...
 
-- <a href="https://github.com/TIBCOSoftware/labs-air" target="_blank">labs-air</a><br>
+- [labs-air](https://github.com/TIBCOSoftware/labs-air)
   stores the Project Site and Documentation (this Repo)
 
-  - <a href="https://github.com/TIBCOSoftware/labs-air-ui" target="_blank">labs-air-ui</a><br>
-  AIR user Interface implemented using Angular.io 
+- [labs-air-ui](https://github.com/TIBCOSoftware/labs-air-ui)
+  AIR user Interface implemented using Angular.io
 
-  - <a href="https://github.com/TIBCOSoftware/labs-air-edgex" target="_blank">labs-air-edgex</a><br>
-  configurations of EdgeX Foundry releated to AIR
+- [labs-air-edgex](https://github.com/TIBCOSoftware/labs-air-edgex)
+  configurations of EdgeX Foundry related to AIR
 
-  - <a href="https://github.com/TIBCOSoftware/labs-air-charts" target="_blank">labs-air-charts</a><br>
-  bootstraps a Project Air deployment on a Kubernetes cluster using the Helm package manager. 
+- [labs-air-charts](https://github.com/TIBCOSoftware/labs-air-charts)
+  bootstraps a Project Air deployment on a Kubernetes cluster using the Helm package manager.
 
-  - <a href="https://github.com/TIBCOSoftware/labs-air-services" target="_blank">labs-air-services</a><br>
+- [labs-air-services](https://github.com/TIBCOSoftware/labs-air-services)
   AIR platform backend and edge services based on TIBCO Flogo
 
-  - <a href="https://github.com/TIBCOSoftware/labs-air-contrib" target="_blank">labs-air-contrib</a><br>
-  AIR platform releated TIBCO Flogo extensions, connectors, and functions
+- [labs-air-contrib](https://github.com/TIBCOSoftware/labs-air-contrib)
+  AIR platform related TIBCO Flogo extensions, connectors, and functions
 
 ![Logo](https://tibcosoftware.github.io/TIBCO-LABS/about/tibcolabs-brand.png "Labs Logo")
diff --git a/commitlint.config.js b/commitlint.config.js
@@ -0,0 +1,15 @@
+module.exports = {
+    extends: ['@commitlint/config-conventional'],
+    rules: {
+        "scope-enum": [
+            2,
+            'always',
+            [
+                'cicd',
+                'infra',
+                'api',
+                'general'
+            ]
+        ]
+    }
+};