From 37a689d382945e7015f8b13f9ad53204b47f83bd Mon Sep 17 00:00:00 2001
From: wkoot <3715211+wkoot@users.noreply.github.com>
Date: Thu, 14 Nov 2024 10:23:06 +0100
Subject: [PATCH] WIP

---
 .github/workflows/markdown-lint.yml           | 21 +++++++
 CHANGELOG.md                                  | 42 +++++++++++++
 tests/.vale.ini                               |  9 +++
 tests/requirements.txt                        |  1 +
 .../config/vocabularies/Base/accept.txt       | 60 +++++++++++++++++++
 .../config/vocabularies/Base/reject.txt       |  3 +
 6 files changed, 136 insertions(+)
 create mode 100644 .github/workflows/markdown-lint.yml
 create mode 100644 CHANGELOG.md
 create mode 100644 tests/.vale.ini
 create mode 100644 tests/styles/config/vocabularies/Base/accept.txt
 create mode 100644 tests/styles/config/vocabularies/Base/reject.txt

diff --git a/.github/workflows/markdown-lint.yml b/.github/workflows/markdown-lint.yml
new file mode 100644
index 0000000..37624ce
--- /dev/null
+++ b/.github/workflows/markdown-lint.yml
@@ -0,0 +1,21 @@
+---
+name: Markdown lint
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+jobs:
+  vale:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: errata-ai/vale-action@v2.1.1
+        with:
+          fail_on_error: true
+          filter_mode: nofilter
+          vale_flags: "--glob='!tests/ *.md' --config=tests/.vale.ini"
diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..7dee71c
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,42 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+- Changelog with backdated changes (#72).
+
+## [10.5.1] - 2024-05-23
+
+### Changed
+
+- Update to [version 10.5.1 of SonarQube](https://www.sonarsource.com/products/sonarqube/whats-new/sonarqube-10-5/) (#76).
+
+## [10.3.0] - 2023-12-22
+
+### Changed
+
+- Update to [version 10.3.0 of SonarQube](https://www.sonarsource.com/products/sonarqube/whats-new/sonarqube-10-3/) (#55).
+
+## [10.1.0] - 2023-09-05
+
+### Changed
+
+- Update to [version 10.1.0 of SonarQube](https://www.sonarsource.com/products/sonarqube/whats-new/sonarqube-10-1/) (#52).
+
+## [9.9.1] - 2023-05-09
+
+### Changed
+
+- Update to version 9.9.1 of SonarQube.
+
+## [9.7.1] - 2022-12-02
+
+### Changed
+
+- Update to version 9.7.1 of SonarQube.
diff --git a/tests/.vale.ini b/tests/.vale.ini
new file mode 100644
index 0000000..b8a4715
--- /dev/null
+++ b/tests/.vale.ini
@@ -0,0 +1,9 @@
+StylesPath = styles
+
+MinAlertLevel = suggestion
+Vocab = Base
+
+Packages = proselint
+
+[*.md]
+BasedOnStyles = Vale, proselint
diff --git a/tests/requirements.txt b/tests/requirements.txt
index 45713d5..1005cfd 100644
--- a/tests/requirements.txt
+++ b/tests/requirements.txt
@@ -1,2 +1,3 @@
 python-sonarqube-api >= 2.0
 requests >= 2.31
+vale >= 3.9.0.0
diff --git a/tests/styles/config/vocabularies/Base/accept.txt b/tests/styles/config/vocabularies/Base/accept.txt
new file mode 100644
index 0000000..04ef8a4
--- /dev/null
+++ b/tests/styles/config/vocabularies/Base/accept.txt
@@ -0,0 +1,60 @@
+Anchore
+APIs
+Caddy
+Checkmarx
+Cobertura
+Dependabot
+Docker-composition
+Dockerfile
+DTDs
+ESLint
+Gravatar
+Jira
+JMeter
+JUnit
+NCover
+Nginx
+OJAudit
+OpenShift
+PDFs
+Pydantic
+Robocop
+Snyk
+Trello
+Trivy
+UUIDs
+Wekan
+[Hh]ostname
+[Uu]nmerged
+asyncio
+autoformatting
+breakpoint
+clearable
+cloc
+discoverability
+donut
+errored
+favicon
+fixme
+hostnames?
+hotspots?
+lookback
+misconfigured
+mypy
+namespace
+npm
+parameterizable
+phpldapadmin
+[Pp]erformancetest
+severities
+sparkline
+subfolders
+submenus
+suppressions
+todo
+tooltips?
+tracebacks?
+unencrypted
+unicode
+unmerged
+upvotes
diff --git a/tests/styles/config/vocabularies/Base/reject.txt b/tests/styles/config/vocabularies/Base/reject.txt
new file mode 100644
index 0000000..70dde23
--- /dev/null
+++ b/tests/styles/config/vocabularies/Base/reject.txt
@@ -0,0 +1,3 @@
+docker composition
+Docker composition
+docker-composition