feat: Add rumdl (#85)

Signed-off-by: Steve Hipwell <steve.hipwell@gmail.com>

Author: stevehipwell

.github/workflows/_validate.yaml

@@ -20,6 +20,6 @@ jobs:
     uses: ./.github/workflows/validate-gh-workflows.yaml
     with:
       auto_doc: true
-      markdownlint: true
       shellcheck: true
       yamlfmt: true
+      rumdl: true

.github/workflows/validate-gh-action.yaml

@@ -8,11 +8,6 @@ on:
         type: boolean
         required: false
         default: false
-      markdownlint:
-        description: If markdownlint should be run.
-        type: boolean
-        required: false
-        default: false
       shellcheck:
         description: If shellcheck should be run.
         type: boolean
@@ -23,6 +18,16 @@ on:
         type: boolean
         required: false
         default: false
+      rumdl:
+        description: If rumdl should be run.
+        type: boolean
+        required: false
+        default: false
+      markdownlint:
+        description: DEPRECATED - If markdownlint should be run.
+        type: boolean
+        required: false
+        default: false
 
 jobs:
   validate:

.github/workflows/validate-gh-workflows.yaml

@@ -12,11 +12,6 @@ on:
         description: The script to run auto-doc.
         type: string
         required: false
-      markdownlint:
-        description: If markdownlint should be run.
-        type: boolean
-        required: false
-        default: false
       shellcheck:
         description: If shellcheck should be run.
         type: boolean
@@ -27,6 +22,16 @@ on:
         type: boolean
         required: false
         default: false
+      rumdl:
+        description: If rumdl should be run.
+        type: boolean
+        required: false
+        default: false
+      markdownlint:
+        description: DEPRECATED - If markdownlint should be run.
+        type: boolean
+        required: false
+        default: false
 
 jobs:
   validate:
@@ -82,7 +87,7 @@ jobs:
               name="$(basename "${file}" .yaml)"
 
               tmp_readme="$(mktemp)"
-              printf '## Inputs\n## Outputs' >"${tmp_readme}"
+              printf '## Secrets\n\n## Inputs\n\n## Outputs' >"${tmp_readme}"
               auto-doc --colMaxWords 100 --repository ${{ github.repository }} --reusable --reusableOutputColumns "Output" --reusableOutputColumns "Description" --filename "${file}" --output "${tmp_readme}"
               sed -i 's/## /### /g' "${tmp_readme}"
               sed -i 's/||/\\|\\|/g' "${tmp_readme}"

.markdownlint.yaml

@@ -0,0 +1,14 @@
+[global]
+disable = ["MD028", "MD013"]
+
+[per-file-ignores]
+".github/pull_request_template.md" = ["MD041"]
+
+[MD024]
+siblings-only = true
+
+[MD033]
+allowed-elements = ["br", "details", "summary", "sub", "sup"]
+
+[MD052]
+shortcut-syntax = true

.rumdl.toml

@@ -15,6 +15,12 @@
 
 ## [UNRELEASED]
 
+## [v0.8.0] - 2026-02-10
+
+### Added
+
+- Add support to lint markdown with [rumdl](https://github.com/rvben/rumdl) via the new `rumdl` input. ([#85](https://github.com/action-stars/generic-workflows/pull/85)) _@stevehipwell_
+
 ### Changed
 
 - Update _actions/checkout_ from `6.0.0` to `6.0.1`. ([#80](https://github.com/action-stars/generic-workflows/pull/80)) _@dependabot_
@@ -222,7 +228,8 @@
 <!--
 RELEASES
 -->
-[UNRELEASED]: https://github.com/action-stars/generic-workflows/compare/v0.7.4...HEAD
+[UNRELEASED]: https://github.com/action-stars/generic-workflows/compare/v0.8.0...HEAD
+[v0.8.0]: https://github.com/action-stars/generic-workflows/releases/tag/v0.8.0
 [v0.7.4]: https://github.com/action-stars/generic-workflows/releases/tag/v0.7.4
 [v0.7.3]: https://github.com/action-stars/generic-workflows/releases/tag/v0.7.3
 [v0.7.2]: https://github.com/action-stars/generic-workflows/releases/tag/v0.7.2

CHANGELOG.md

@@ -8,11 +8,18 @@
 This GitHub Actions workflow generates a changelog for Dependabot.
 
 <!-- MERGE:START:dependabot-changelog - Do not remove or modify this section -->
+### Secrets
+
+<!-- AUTO-DOC-SECRETS:START - Do not remove or modify this section -->
+No secrets.
+<!-- AUTO-DOC-SECRETS:END -->
+
 ### Inputs
 
 <!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->
 No inputs.
 <!-- AUTO-DOC-INPUT:END -->
+
 ### Outputs
 
 <!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->
@@ -25,6 +32,12 @@ No outputs.
 This GitHub Actions workflow publishes a release.
 
 <!-- MERGE:START:release - Do not remove or modify this section -->
+### Secrets
+
+<!-- AUTO-DOC-SECRETS:START - Do not remove or modify this section -->
+No secrets.
+<!-- AUTO-DOC-SECRETS:END -->
+
 ### Inputs
 
 <!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->
@@ -37,6 +50,7 @@ This GitHub Actions workflow publishes a release.
 |    version     | string  |  false   | `"${{ github.ref_name }}"` |                                The version to be released.                                |
 
 <!-- AUTO-DOC-INPUT:END -->
+
 ### Outputs
 
 <!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->
@@ -49,6 +63,12 @@ No outputs.
 This GitHub Actions workflow runs the OSSF Scorecard.
 
 <!-- MERGE:START:scorecard - Do not remove or modify this section -->
+### Secrets
+
+<!-- AUTO-DOC-SECRETS:START - Do not remove or modify this section -->
+No secrets.
+<!-- AUTO-DOC-SECRETS:END -->
+
 ### Inputs
 
 <!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->
@@ -58,6 +78,7 @@ This GitHub Actions workflow runs the OSSF Scorecard.
 | retention_days | number |  false   |   `7`   | Number of days to retain the scorecard artifact. |
 
 <!-- AUTO-DOC-INPUT:END -->
+
 ### Outputs
 
 <!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->
@@ -70,18 +91,26 @@ No outputs.
 This workflow validates the GitHub Action in the repository.
 
 <!-- MERGE:START:validate-gh-action - Do not remove or modify this section -->
+### Secrets
+
+<!-- AUTO-DOC-SECRETS:START - Do not remove or modify this section -->
+No secrets.
+<!-- AUTO-DOC-SECRETS:END -->
+
 ### Inputs
 
 <!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->
 
-|    INPUT     |  TYPE   | REQUIRED | DEFAULT |          DESCRIPTION           |
-|--------------|---------|----------|---------|--------------------------------|
-|   auto_doc   | boolean |  false   | `false` |   If auto-doc should be run.   |
-| markdownlint | boolean |  false   | `false` | If markdownlint should be run. |
-|  shellcheck  | boolean |  false   | `false` |  If shellcheck should be run.  |
-|   yamlfmt    | boolean |  false   | `false` |   If yamlfmt should be run.    |
+|    INPUT     |  TYPE   | REQUIRED | DEFAULT |                 DESCRIPTION                 |
+|--------------|---------|----------|---------|---------------------------------------------|
+|   auto_doc   | boolean |  false   | `false` |         If auto-doc should be run.          |
+| markdownlint | boolean |  false   | `false` | DEPRECATED - If markdownlint should be run. |
+|    rumdl     | boolean |  false   | `false` |           If rumdl should be run.           |
+|  shellcheck  | boolean |  false   | `false` |        If shellcheck should be run.         |
+|   yamlfmt    | boolean |  false   | `false` |          If yamlfmt should be run.          |
 
 <!-- AUTO-DOC-INPUT:END -->
+
 ### Outputs
 
 <!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->
@@ -94,19 +123,27 @@ No outputs.
 This workflow validates the GitHub Workflows in the repository.
 
 <!-- MERGE:START:validate-gh-workflows - Do not remove or modify this section -->
+### Secrets
+
+<!-- AUTO-DOC-SECRETS:START - Do not remove or modify this section -->
+No secrets.
+<!-- AUTO-DOC-SECRETS:END -->
+
 ### Inputs
 
 <!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->
 
-|      INPUT      |  TYPE   | REQUIRED | DEFAULT |          DESCRIPTION           |
-|-----------------|---------|----------|---------|--------------------------------|
-|    auto_doc     | boolean |  false   | `false` |   If auto-doc should be run.   |
-| auto_doc_script | string  |  false   |         |  The script to run auto-doc.   |
-|  markdownlint   | boolean |  false   | `false` | If markdownlint should be run. |
-|   shellcheck    | boolean |  false   | `false` |  If shellcheck should be run.  |
-|     yamlfmt     | boolean |  false   | `false` |   If yamlfmt should be run.    |
+|      INPUT      |  TYPE   | REQUIRED | DEFAULT |                 DESCRIPTION                 |
+|-----------------|---------|----------|---------|---------------------------------------------|
+|    auto_doc     | boolean |  false   | `false` |         If auto-doc should be run.          |
+| auto_doc_script | string  |  false   |         |         The script to run auto-doc.         |
+|  markdownlint   | boolean |  false   | `false` | DEPRECATED - If markdownlint should be run. |
+|      rumdl      | boolean |  false   | `false` |           If rumdl should be run.           |
+|   shellcheck    | boolean |  false   | `false` |        If shellcheck should be run.         |
+|     yamlfmt     | boolean |  false   | `false` |          If yamlfmt should be run.          |
 
 <!-- AUTO-DOC-INPUT:END -->
+
 ### Outputs
 
 <!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->

README.md

@@ -1,6 +1,6 @@
 $ErrorActionPreference = "Stop"
 
-$repository = "lexisnexis-iac/workflows"
+$repository = "action-stars/generic-workflows"
 $readmePath = "./README.md"
 
 # Find all relevant YAML files
@@ -11,7 +11,7 @@ foreach ($file in $workflowFiles) {
   $tmpReadme = New-TemporaryFile
 
   # Create initial content for the temporary README
-  "## Inputs`n## Outputs`n" | Out-File -FilePath $tmpReadme.FullName -Encoding UTF8 -NoNewline
+  "## Secrets`n`n## Inputs`n`n## Outputs`n" | Out-File -FilePath $tmpReadme.FullName -Encoding UTF8 -NoNewline
 
   # Generate documentation using auto-doc
   & auto-doc --colMaxWords 100 --repository $repository --reusable --reusableOutputColumns "Output" --reusableOutputColumns "Description" --filename $file.FullName --output $tmpReadme.FullName

hack/docs.ps1

@@ -7,7 +7,7 @@ find ./.github/workflows -maxdepth 1 -name '*.yaml' ! -name '_*' -print0 | while
   name="$(basename "${file}" .yaml)"
 
   tmp_readme="$(mktemp)"
-  printf '## Inputs\n## Outputs' >"${tmp_readme}"
+  printf '## Secrets\n\n## Inputs\n\n## Outputs' >"${tmp_readme}"
   auto-doc --colMaxWords 100 --repository "${repository}" --reusable --reusableOutputColumns "Output" --reusableOutputColumns "Description" --filename "${file}" --output "${tmp_readme}"
   sed -i 's/## /### /g' "${tmp_readme}"
   sed -i 's/||/\\|\\|/g' "${tmp_readme}"

hack/docs.sh

@@ -1,19 +1,22 @@
 set windows-shell := ["pwsh", "-NoLogo", "-Command"]
 
 default:
-  just --list
+    just --list
 
 actionlint:
-  actionlint -shellcheck=shellcheck
+    actionlint -shellcheck=shellcheck
 
-markdownlint:
-  npm exec markdownlint-cli2 --yes -- --fix "**/*.{md,markdown}"
+mdfmt:
+    rumdl fmt --fix .
+
+mdlint:
+    rumdl check .
 
 shellcheck:
-  {{ if os_family() == "windows" { "Get-ChildItem -Recurse -File | Where-Object { $_.Extension -eq '.sh' } | ForEach-Object { & shellcheck $_.FullName }" } else { "find . -type f -name '*.sh' | xargs --no-run-if-empty -n1 shellcheck" } }}
+    {{ if os_family() == "windows" { "Get-ChildItem -Recurse -File | Where-Object { $_.Extension -eq '.sh' } | ForEach-Object { & shellcheck $_.FullName }" } else { "find . -type f -name '*.sh' | xargs --no-run-if-empty -n1 shellcheck" } }}
 
 yamlfmt:
-  yamlfmt -continue_on_error
+    yamlfmt -continue_on_error
 
 docs:
-  {{ if os_family() == "windows" { "./hack/docs.ps1" } else { "./hack/docs.sh" } }}
+    {{ if os_family() == "windows" { "./hack/docs.ps1" } else { "./hack/docs.sh" } }}