Merge pull request #102 from anarnold97/MTA-4748-Adding-Vale-to-MTA-GitHub-repo

MTA-4748: Adding Vale to MTA GitHub repo

Author: anarnold97

.github/workflows/lint-with-vale.yml

@@ -0,0 +1,26 @@
+---
+name: Linting with Vale on pull request
+on: [pull_request]
+
+jobs:
+  vale:
+    name: Linting with Vale
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install Asciidoctor
+        run: sudo apt-get install -y asciidoctor
+      - uses: errata-ai/vale-action@reviewdog
+        with:
+          filter_mode: diff_context
+          vale_flags: "--no-exit --minAlertLevel=error"
+          reporter: github-pr-review
+          # Radhika says not to block PR merge if there are Vale errors
+          # To change set fail_on_error: true
+          fail_on_error: false
+        env:
+          # Required, set by GitHub actions automatically:
+          # https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+          REVIEWDOG_GITHUB_API_TOKEN: ${{secrets.GITHUB_TOKEN}}
+ 

vale.ini

@@ -0,0 +1,40 @@
+StylesPath = .vale/styles
+
+MinAlertLevel = suggestion
+
+IgnoredScopes = code, tt, img, url, a, body.id
+
+SkippedScopes = script, style, pre, figure, code, tt, blockquote, listingblock, literalblock
+
+Packages = RedHat, proselint, write-good
+
+# Match AsciiDoc files. See: https://vale.sh/docs/topics/scoping/
+# Ignore files in a directory starting by `.`
+# to avoid raising errors for `.vale/fixtures/*/testinvalid.adoc` files
+[[!.]*.adoc]
+
+BasedOnStyles = RedHat, proselint, write-good
+
+[*.md]
+
+BasedOnStyles = RedHat, proselint, write-good
+
+# Ignore code surrounded by backticks or plus sign, parameters defaults, URLs.
+TokenIgnores = (\x60[^\n\x60]+\x60), ([^\n]+=[^\n]*), (\+[^\n]+\+), (http[^\n]+\[)
+
+# Match INI files. See: https://vale.sh/docs/topics/scoping/
+[*.ini]
+
+BasedOnStyles = RedHat
+
+# Ignore code surrounded by backticks or plus sign, parameters defaults, URLs.
+TokenIgnores = (\x60[^\n\x60]+\x60), ([^\n]+=[^\n]*), (\+[^\n]+\+), (http[^\n]+\[)
+
+# Disabling rules (NO)
+RedHat.CaseSensitiveTerms = NO
+RedHat.ConfigMap = NO
+RedHat.Definitions = NO
+RedHat.Slash = NO
+RedHat.Spacing = NO
+RedHat.Spelling = NO
+RedHat.TermsSuggestions = NO