Markdown linter and link checker jobs

Author: soumeh01

.github/markdown-link-check.jsonc

@@ -0,0 +1,10 @@
+{
+  "httpHeaders": [
+    {
+      "urls": ["https://github.com/", "https://guides.github.com/", "https://help.github.com/", "https://docs.github.com/"],
+      "headers": {
+        "Accept-Encoding": "zstd, br, gzip, deflate"
+      }
+    }
+  ],
+}

.github/markdownlint.json

@@ -0,0 +1,18 @@
+{
+  "problemMatcher": [
+    {
+      "owner": "markdownlint",
+      "severity": "warning",
+      "pattern": [
+        {
+          "regexp": "^(.*):(\\d+)(:(\\d+))? (MD\\d+\\/[^ ]+) (.*)$",
+          "file": 1,
+          "line": 2,
+          "column": 4,
+          "code": 5,
+          "message": 6
+        }
+      ]
+    }
+  ]
+}

.github/markdownlint.jsonc

@@ -0,0 +1,8 @@
+{
+  "default": true,
+  "MD013": {
+    "line_length": 120
+  },
+  "MD034": false,
+  "MD041": false
+}

.github/workflows/markdown.yml

@@ -0,0 +1,54 @@
+name: Markdown
+
+on:
+  pull_request:
+    paths:
+      - '.github/workflows/markdown.yml'
+      - '.github/markdownlint.json'
+      - '.github/markdownlint.jsonc'
+      - '**/*.md'
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  linter:
+    name: Lint Markdown Files
+    runs-on: ubuntu-latest
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@0634a2670c59f64b4a01f0f96f84700a4088b9f0 # v2.12.0
+        with:
+          egress-policy: audit
+
+      - name: Checkout vscode-cmsis-debugger
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
+      - name: Register Markdownlint Warning Matcher
+        run: echo "::add-matcher::.github/markdownlint.json"
+
+      - name: Lint Markdown Files
+        uses: avto-dev/markdown-lint@04d43ee9191307b50935a753da3b775ab695eceb # v1.5.0
+        with:
+          args: '**/*.md'
+          config: '.github/markdownlint.jsonc'
+
+      - name: Remove Markdownlint Warning Matcher
+        if: always()
+        run: echo "::remove-matcher owner=markdownlint::"
+
+  check-links:
+    name: Check Markdown Links
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
+      - name: Check Links
+        uses: gaurav-nelson/github-action-markdown-link-check@3c3b66f1f7d0900e37b71eca45b63ea9eedfce31 # master
+        with:
+          use-quiet-mode: 'yes'
+          use-verbose-mode: 'yes'
+          base-branch: ${{ github.base_ref }}
+          config-file: '.github/markdown-link-check.jsonc'

CHANGELOG.md

@@ -1,49 +1,78 @@
 # Change Log
 
 ## 0.1.1
-- Fixes [#153](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/issues/153): PATH variable in terminal sometimes loses modifications from other extensions.
-- Fixes [#155](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/issues/155): Go-to-main in `initCommands` of the `launch.json` leaves behind the breakpoint.
-- Partially implements [#96](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/issues/96): Enable Peripheral Inspector.
-  - Extracts first SVD file path found in `*.cbuild-run.yml` debug configuration file to automatically set up Peripheral Inspector.
+
+- Fixes [#153](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/issues/153): PATH variable in terminal sometimes
+loses modifications from other extensions.
+- Fixes [#155](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/issues/155): Go-to-main in `initCommands` of the
+`launch.json` leaves behind the breakpoint.
+- Partially implements [#96](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/issues/96): Enable Peripheral
+Inspector.
+  - Extracts first SVD file path found in `*.cbuild-run.yml` debug configuration file to automatically set up
+  Peripheral Inspector.
 - Adds initial version of extension [documentation](https://open-cmsis-pack.github.io/vscode-cmsis-debugger/).
 - Updates included pyOCD distribution
-  - Fixes [#133](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/issues/133): Adds default memory map for Cortex-M devices.
+  - Fixes [#133](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/issues/133): Adds default memory map for
+  Cortex-M devices.
   - Improves memory map creation and flash algorithms sorting.
   - Selects current processor core (for example used for flash programming) based on active gdb server connection.
 
 ## 0.1.0
+
 - Updates included pyOCD distribution
-  - Fixes [#92](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/issues/92): `monitor reset halt` command fails for LPCXpresso55S69 if using CMSIS Pack support in pyOCD.
-  - Fixes [#93](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/issues/93): Download to LPC55S69 flash with GDB and pyOCD ends in errors.
-  - Fixes [#94](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/issues/94): Cannot connect to NXP FRDM-K32L3A6 with pyOCD.
+  - Fixes [#92](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/issues/92): `monitor reset halt` command fails
+  for LPCXpresso55S69 if using CMSIS Pack support in pyOCD.
+  - Fixes [#93](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/issues/93): Download to LPC55S69 flash with
+  GDB and pyOCD ends in errors.
+  - Fixes [#94](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/issues/94): Cannot connect to NXP FRDM-K32L3A6
+  with pyOCD.
   - Fixes support for `<memory>` elements from CMSIS PDSC files.
   - Fixes progress bar output during program download.
   - Fixes handling of `__ap` variable in debug sequences.
-  - Improves connection robustness and DP sticky error bits handling for temporary target communication losses and `__errorcontrol` usage (CMSIS debug descriptions). For example in reset scenarios.
+  - Improves connection robustness and DP sticky error bits handling for temporary target communication losses and
+   `__errorcontrol` usage (CMSIS debug descriptions). For example in reset scenarios.
   - Updates CMSIS-DAP probe detection (filters out Cypress KitProg3 bridge).
   - Extends and improves support for `*.cbuild-run.yml` debug configuration files.
 
 ## 0.0.3
-- Fixes [#84](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/issues/84): Cannot use cbuild-run files with pyOCD without CMSIS_PACK_ROOT environment variable.
-- Implements [#83](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/issues/83): Make built-in pyOCD available in VS Code terminals.
-  - Note that there is a known issue with a pyOCD installation in Python virtual environments taking precedence over the built-in pyOCD variant.
+
+- Fixes [#84](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/issues/84): Cannot use cbuild-run files with
+pyOCD without CMSIS_PACK_ROOT environment variable.
+- Implements [#83](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/issues/83): Make built-in pyOCD available
+in VS Code terminals.
+  - Note that there is a known issue with a pyOCD installation in Python virtual environments taking precedence over
+  the built-in pyOCD variant.
 - Updates included pyOCD distribution
-  - Fixes [#91](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/issues/91): "Zephyr kernel detected" warning in shipped pyOCD.
-  - Fixes [#100](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/issues/100): [macOS] - Cannot connect with pyOCD and ULINKplus. Fixes missing `libusb` for macOS.
-  - Fixes [#126](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/issues/126): Flash programming fails on devices where the flash memory's erased value is 0x00. Initializes XPSR register before executing flash algorithm function.
-  - Fixes [#127](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/issues/127): CoreSight root component discovery fails. Fixes how to address APv2.
-  - Fixes [#128](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/issues/128): Programming fails on LPC55S69 when device is erased. Debugger no longer reads back programmed flash memory if `Verify` function is provided by flash algorithm.
-  - Fixes [#131](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/issues/131): AP access failure due to invalid security flags (SPROT).
+  - Fixes [#91](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/issues/91): "Zephyr kernel detected" warning
+  in shipped pyOCD.
+  - Fixes [#100](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/issues/100): [macOS] - Cannot connect with
+  pyOCD and ULINKplus. Fixes missing `libusb` for macOS.
+  - Fixes [#126](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/issues/126): Flash programming fails on
+  devices where the flash memory's erased value is 0x00. Initializes XPSR register before executing flash algorithm
+  function.
+  - Fixes [#127](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/issues/127): CoreSight root component
+  discovery fails. Fixes how to address APv2.
+  - Fixes [#128](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/issues/128): Programming fails on LPC55S69
+   when device is erased. Debugger no longer reads back programmed flash memory if `Verify` function is
+   provided by flash algorithm.
+  - Fixes [#131](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/issues/131):
+   AP access failure due to invalid security flags (SPROT).
   - Extends support for `*.cbuild-run.yml` debug configuration files.
 
 ## 0.0.2
-- Removes [Arm Tools Environment Manager](https://marketplace.visualstudio.com/items?itemName=Arm.environment-manager) from extension pack. Instead, README lists it as one of the recommended extensions to use with the Arm CMSIS Debugger.
+
+- Removes [Arm Tools Environment Manager](https://marketplace.visualstudio.com/items?itemName=Arm.environment-manager)
+ from extension pack. Instead, README lists it as one of the recommended extensions to use with the Arm CMSIS Debugger.
 - Fixes use of `${workspace}` to `${workspaceFolder}` in default debug configurations.
-- Reduces and aligns default `initCommands` lists for pseudo debugger types `cmsis-debug-pyocd` and `cmsis-debug-jlink`.
-- Implements [#69](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/issues/69): Bring Debug Console to front during connection.
+- Reduces and aligns default `initCommands` lists for pseudo debugger types `cmsis-debug-pyocd`
+ and `cmsis-debug-jlink`.
+- Implements [#69](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/issues/69): Bring Debug Console to
+ front during connection.
 
 ## 0.0.1
+
 - Initial release of extension pack on GitHub.
 - Adds pseudo debugger types `cmsis-debug-pyocd` and `cmsis-debug-jlink`.
-- Adds debug configuration providers for debugger type `gdbtarget` to resolve settings for pyOCD and Segger J-Link GDB server connections.
+- Adds debug configuration providers for debugger type `gdbtarget` to resolve settings for pyOCD and Segger J-Link
+ GDB server connections.
 - Contributes setting `cmsis`.`cbuildRunFile` to all debugger types (`*` debugger type).