Skip to content

chore(markdown): add markdownlint CI job and fix lint violations#1753

Merged
jakobmoellerdev merged 7 commits into
open-component-model:mainfrom
jakobmoellerdev:markdownlint
Apr 10, 2026
Merged

chore(markdown): add markdownlint CI job and fix lint violations#1753
jakobmoellerdev merged 7 commits into
open-component-model:mainfrom
jakobmoellerdev:markdownlint

Conversation

@jakobmoellerdev

Copy link
Copy Markdown
Member

What this PR does / why we need it

  • Add lint job to markdown.yml workflow using task tools:markdownlint
  • Add markdownlint and markdownlint/install tasks to tools.Taskfile.yml with version management

Which issue(s) this PR fixes

runs automatic linting and gives a task to fix that linting.

@github-actions github-actions Bot added component/github-actions Changes on GitHub Actions or within `.github/` directory area/documentation Documentation related size/m Medium labels Feb 10, 2026
@jakobmoellerdev jakobmoellerdev changed the title ci(markdown): add markdownlint CI job and fix lint violations chore(markdown): add markdownlint CI job and fix lint violations Feb 16, 2026
@github-actions github-actions Bot added the kind/chore chore, maintenance, etc. label Feb 16, 2026
Comment thread tools.Taskfile.yml Outdated
Comment thread tools.Taskfile.yml Outdated
@coderabbitai

coderabbitai Bot commented Apr 3, 2026

Copy link
Copy Markdown
Contributor

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

Adds markdownlint configuration and CI integration (Taskfile, .env, GitHub Actions job) and applies widespread Markdown formatting fixes: code-fence languages, list indentation, trailing newlines, and URL formatting across many docs. No code-level exports changed.

Changes

Cohort / File(s) Summary
Lint configuration
\.github/config/.markdownlint-cli2.yaml, cli/docs/reference/.markdownlint-cli2.yaml
Added ignores for kubernetes/controller/chart/README.md and website/**; disabled MD060 in main config and MD032 in CLI docs config.
CI / Taskfile / env
\.github/workflows/markdown.yml, tools.Taskfile.yml, .env
Added GitHub Actions lint job that runs pinned markdownlint-cli2 (reads MARKDOWNLINT_CLI2_VERSION from .env); added markdownlint Taskfile task and MARKDOWNLINT_CLI2_VERSION pin.
Documentation edits
CONTRIBUTING.md, RELEASE_PROCESS.md, conformance/README.md, conformance/scenarios/sovereign/README.md, docs/adr/0012_construct_as_transformation.md, docs/adr/0013_sovereign_cloud_reference_scenario.md, docs/adr/0014_conformance_test_suite.md, docs/community/README.md, docs/steering/GOVERNANCE.md, docs/steering/meeting-notes/*, docs/steering/meeting-notes/..., docs/...
Formatting-only changes across many Markdown files: normalized fenced block languages, adjusted list nesting/indentation, added trailing newlines, converted some URLs to <...> inline form, and standardized emphasis. No semantic/content changes.
Minor README/Tweaks
cli/docs/reference/.markdownlint-cli2.yaml, conformance/README.md
Small config and newline fixes (disabled MD032; added trailing newline).

Sequence Diagram(s)

sequenceDiagram
    participant GH as GitHub Actions
    participant Repo as Repository
    participant Runner as Actions Runner (node setup)
    participant npx as npx/markdownlint-cli2

    GH->>Repo: workflow triggered (markdown.yml)
    GH->>Runner: start job "lint"
    Runner->>Repo: source .env (read MARKDOWNLINT_CLI2_VERSION)
    Runner->>Runner: setup Node.js
    Runner->>npx: run npx markdownlint-cli2@${MARKDOWNLINT_CLI2_VERSION} --config .github/config/.markdownlint-cli2.yaml "**/*.md"
    npx->>Repo: read config & ignores, lint markdown files
    npx-->>Runner: exit code / report
    Runner-->>GH: job success/failure
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Suggested reviewers

  • Skarlso

Poem

🐇 I hopped through README, note, and fence,
Nudged lines to neatness, made spacing sense.
A linting bell rings in the night,
Docs now tidy, soft and bright.
Hop on — the markdown's feeling light!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the main changes: adding markdownlint CI job and fixing lint violations across the repository.
Description check ✅ Passed The description is related to the changeset, outlining the CI job addition and markdownlint task integration, though somewhat brief on specific implementation details.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions github-actions Bot added the size/l Large label Apr 3, 2026
@gitguardian

gitguardian Bot commented Apr 3, 2026

Copy link
Copy Markdown

️✅ There are no secrets present in this pull request anymore.

If these secrets were true positive and are still valid, we highly recommend you to revoke them.
While these secrets were previously flagged, we no longer have a reference to the
specific commits where they were detected. Once a secret has been leaked into a git
repository, you should consider it compromised, even if it was deleted immediately.
Find here more information about risks.


🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

@jakobmoellerdev

Copy link
Copy Markdown
Member Author

Addressed review feedback:

  • Replaced the custom markdownlint/install task with direct npx markdownlint-cli invocation — no install step needed
  • Updated both tools.Taskfile.yml and the CI workflow (markdown.yml) to use npx markdownlint-cli directly
  • Rebased on main to pick up the latest commits

@jakobmoellerdev

Copy link
Copy Markdown
Member Author

Rebased on main and updated the linter approach:

  • Switched from markdownlint-cli to markdownlint-cli2 — it respects per-directory .markdownlint-cli2.yaml configs (important for cli/docs/reference/ which has its own config)
  • Fixed all pre-existing violations across the repo (98 errors → 0) using --fix and manual fixes
  • CI now runs clean

@jakobmoellerdev jakobmoellerdev marked this pull request as ready for review April 3, 2026 13:15
@jakobmoellerdev jakobmoellerdev requested a review from a team as a code owner April 3, 2026 13:15

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (3)
cli/docs/reference/.markdownlint-cli2.yaml (1)

12-12: Consider adding a comment explaining MD032 disable.

For consistency with other rule disables in this file, consider adding a comment explaining why MD032 (lists should be surrounded by blank lines) is disabled for CLI-generated documentation.

📝 Suggested addition
  MD046: false # cobra uses both fenced and indented code block styles in different sections
- MD032: false
+ MD032: false # cobra generates lists without surrounding blank lines in some contexts
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@cli/docs/reference/.markdownlint-cli2.yaml` at line 12, Add a brief inline
comment next to the MD032: false entry explaining why the "lists should be
surrounded by blank lines" rule is disabled for this section (e.g., because
CLI-generated docs intentionally omit surrounding blank lines), by updating the
configuration entry for MD032: false so the comment is adjacent to that exact
key to match the style of other rule disables in the file.
.github/workflows/markdown.yml (1)

34-40: Consider aligning the command structure with the local Taskfile.

The CI command uses a different argument order than the local task markdownlint command in tools.Taskfile.yml:

  • CI: npx markdownlint-cli2 "**/*.md" --config ...
  • Local: npx markdownlint-cli2 --config ... '{{ .ROOT_DIR }}/**/*.md'

While markdownlint-cli2 should handle both orderings, aligning them would ensure developers get identical results locally and in CI, reducing potential debugging friction.

♻️ Suggested alignment with local Taskfile
       - name: Run linter
-        run: npx markdownlint-cli2 "**/*.md" --config .github/config/.markdownlint-cli2.yaml
+        run: npx markdownlint-cli2 --config .github/config/.markdownlint-cli2.yaml "**/*.md"
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In @.github/workflows/markdown.yml around lines 34 - 40, Update the "Run linter"
step in the GitHub workflow so the markdownlint-cli2 invocation matches the
local Taskfile invocation used by the task named "markdownlint" in
tools.Taskfile.yml: move the --config argument before the file glob and use the
same root-aware glob (the Taskfile's '{{ .ROOT_DIR }}/**/*.md' pattern or an
equivalent explicit repo-root path) so CI runs the same command order and target
files as local `task markdownlint`.
tools.Taskfile.yml (1)

108-114: Consider aligning CI workflow to use this task.

The task is well-structured, but the CI workflow (.github/workflows/markdown.yml lines 34-40) runs npx markdownlint-cli2 directly instead of invoking task tools:markdownlint. This creates potential for configuration drift between local and CI environments.

Consider updating the CI workflow to use:

run: task tools:markdownlint

This would ensure consistent behavior between local development and CI, and centralize the markdownlint configuration in one place.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@tools.Taskfile.yml` around lines 108 - 114, The CI is invoking markdownlint
directly which can diverge from the Taskfile task; update the workflow step that
currently runs the direct npx command to instead execute the Taskfile task by
replacing that run command with "task tools:markdownlint" so the CI uses the
same 'markdownlint' task definition and variables as local/dev environments.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@tools.Taskfile.yml`:
- Line 6: The MARKDOWNLINT_CLI2_TARGET_VERSION variable is undefined and unused;
either add MARKDOWNLINT_CLI2_VERSION to the .env and pin markdownlint installs
to MARKDOWNLINT_CLI2_TARGET_VERSION (update the markdownlint task to install/use
the target version via the same pattern as GOLANGCI_LINT_TARGET_VERSION and
DEEPCOPY_GEN_TARGET_VERSION) or remove the MARKDOWNLINT_CLI2_TARGET_VERSION
declaration entirely and keep the markdownlint task using npx; update references
in the markdownlint task (the task name "markdownlint" and any npx invocation)
to consistently use the chosen approach.

---

Nitpick comments:
In @.github/workflows/markdown.yml:
- Around line 34-40: Update the "Run linter" step in the GitHub workflow so the
markdownlint-cli2 invocation matches the local Taskfile invocation used by the
task named "markdownlint" in tools.Taskfile.yml: move the --config argument
before the file glob and use the same root-aware glob (the Taskfile's '{{
.ROOT_DIR }}/**/*.md' pattern or an equivalent explicit repo-root path) so CI
runs the same command order and target files as local `task markdownlint`.

In `@cli/docs/reference/.markdownlint-cli2.yaml`:
- Line 12: Add a brief inline comment next to the MD032: false entry explaining
why the "lists should be surrounded by blank lines" rule is disabled for this
section (e.g., because CLI-generated docs intentionally omit surrounding blank
lines), by updating the configuration entry for MD032: false so the comment is
adjacent to that exact key to match the style of other rule disables in the
file.

In `@tools.Taskfile.yml`:
- Around line 108-114: The CI is invoking markdownlint directly which can
diverge from the Taskfile task; update the workflow step that currently runs the
direct npx command to instead execute the Taskfile task by replacing that run
command with "task tools:markdownlint" so the CI uses the same 'markdownlint'
task definition and variables as local/dev environments.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 40b5f80d-3c9c-4284-ab7e-8c99ffa71f60

📥 Commits

Reviewing files that changed from the base of the PR and between 8803afa and 39b9029.

📒 Files selected for processing (19)
  • .github/config/.markdownlint-cli2.yaml
  • .github/workflows/markdown.yml
  • CONTRIBUTING.md
  • RELEASE_PROCESS.md
  • cli/docs/reference/.markdownlint-cli2.yaml
  • conformance/README.md
  • conformance/scenarios/sovereign/README.md
  • docs/adr/0012_construct_as_transformation.md
  • docs/adr/0013_sovereign_cloud_reference_scenario.md
  • docs/adr/0014_conformance_test_suite.md
  • docs/community/README.md
  • docs/steering/GOVERNANCE.md
  • docs/steering/meeting-notes/2025-11-03.md
  • docs/steering/meeting-notes/2025-12-01.md
  • docs/steering/meeting-notes/2026-01-05.md
  • docs/steering/meeting-notes/2026-02-02.md
  • docs/steering/meeting-notes/2026-03-02.md
  • docs/steering/meeting-notes/2026-04-06.md
  • tools.Taskfile.yml

Comment thread tools.Taskfile.yml
Comment thread cli/docs/reference/.markdownlint-cli2.yaml Outdated
frewilhelm
frewilhelm previously approved these changes Apr 8, 2026
Comment thread RELEASE_PROCESS.md
Comment thread .github/workflows/markdown.yml Outdated

@Skarlso Skarlso left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have two comments, other then that this looks okay. 👍

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In @.env:
- Line 14: The .env file currently lacks a trailing newline which triggers
dotenv-linter's EndingBlankLine; open the .env file and add a single newline
character at the end of the file (after the MARKDOWNLINT_CLI2_VERSION=0.22.0
line) so the file ends with a blank line/EOF newline to satisfy the linter.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: f3ff9207-31c4-46f0-961c-b615f14ba710

📥 Commits

Reviewing files that changed from the base of the PR and between 8b07d5b and 9babdb1.

📒 Files selected for processing (3)
  • .env
  • .github/workflows/markdown.yml
  • tools.Taskfile.yml
🚧 Files skipped from review as they are similar to previous changes (1)
  • .github/workflows/markdown.yml

Comment thread .env
@Skarlso

Skarlso commented Apr 9, 2026

Copy link
Copy Markdown
Contributor

Thanks. I will "fix" the spell checker in my followup for the website. :)

@coderabbitai

coderabbitai Bot commented Apr 9, 2026

Copy link
Copy Markdown
Contributor

Caution

Review failed

An error occurred during the review process. Please try again later.

📝 Walkthrough

Walkthrough

This PR adds Markdown linting infrastructure (config, Taskfile task, and a GitHub Actions job) and applies widespread documentation formatting fixes: code fence types, list indentation, trailing newlines, and URL formatting across many Markdown files.

Changes

Cohort / File(s) Summary
Markdownlint Config
\.github/config/.markdownlint-cli2.yaml, cli/docs/reference/.markdownlint-cli2.yaml
Updated lint config: added an ignores entry for a Helm-generated README and disabled rules MD060 and MD032.
CI / Taskfile
\.github/workflows/markdown.yml, tools.Taskfile.yml, .env
Added GitHub Actions lint job using pinned markdownlint-cli2; added markdownlint Taskfile task and environment pin MARKDOWNLINT_CLI2_VERSION.
Documentation edits (many files)
CONTRIBUTING.md, RELEASE_PROCESS.md, conformance/README.md, conformance/scenarios/sovereign/README.md, docs/adr/0012_construct_as_transformation.md, docs/adr/0013_sovereign_cloud_reference_scenario.md, docs/adr/0014_conformance_test_suite.md, docs/community/README.md, docs/steering/GOVERNANCE.md, docs/steering/meeting-notes/*, cli/docs/reference/...
Formatting-only changes across many Markdown files: normalized code-fence languages, adjusted list indentation, converted some inline URLs to <...> form, standardized emphasis, and ensured trailing newlines. No semantic changes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~15 minutes

Suggested reviewers

  • frewilhelm
  • morri-son

Poem

🐇 I hopped through lines both old and new,
Tucked fences, spaces, links—how true!
A linting friend now guards the glade,
Neat docs and rules in tidy braid.
Hop on—formatting's freshly made!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main changes: adding a markdownlint CI job and fixing markdown lint violations throughout the repository.
Description check ✅ Passed The description is related to the changeset, explaining the addition of the lint job and Taskfile tasks for markdown linting, though it could be more detailed.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@netlify

netlify Bot commented Apr 10, 2026

Copy link
Copy Markdown

Deploy Preview for ocm-website ready!

Name Link
🔨 Latest commit f0c0288
🔍 Latest deploy log https://app.netlify.com/projects/ocm-website/deploys/69d91d88ff579800080242e2
😎 Deploy Preview https://deploy-preview-1753--ocm-website.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@github-actions github-actions Bot removed the size/l Large label Apr 10, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

♻️ Duplicate comments (1)
.env (1)

14-14: ⚠️ Potential issue | 🟡 Minor

Add trailing newline at EOF.

This still trips dotenv-linter (EndingBlankLine) and creates avoidable CI noise.

Suggested fix
 MARKDOWNLINT_CLI2_VERSION=0.22.0
+
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In @.env at line 14, The .env file is missing a trailing newline which triggers
dotenv-linter's EndingBlankLine; open the .env file and add a single newline
character at EOF so the last entry (MARKDOWNLINT_CLI2_VERSION=0.22.0) is
followed by a blank line, then save the file to remove the linter warning.
🧹 Nitpick comments (1)
docs/steering/meeting-notes/2026-03-02.md (1)

44-44: Optional wording polish: hyphenate “blog-style page”.

Tiny readability/grammar cleanup for the phrase.

Suggested tweak
-  - [x] Gerald to check for a blog style page for announcements etc. on the website. (Jakob & Gerald to plan)
+  - [x] Gerald to check for a blog-style page for announcements etc. on the website. (Jakob & Gerald to plan)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/steering/meeting-notes/2026-03-02.md` at line 44, Update the checklist
item text to hyphenate “blog-style page”: replace the phrase "a blog style page
for announcements etc. on the website." in the meeting note line containing
"Gerald to check for a blog style page for announcements etc. on the website.
(Jakob & Gerald to plan)" with "a blog-style page for announcements etc. on the
website." so it reads with the correct hyphenation.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Duplicate comments:
In @.env:
- Line 14: The .env file is missing a trailing newline which triggers
dotenv-linter's EndingBlankLine; open the .env file and add a single newline
character at EOF so the last entry (MARKDOWNLINT_CLI2_VERSION=0.22.0) is
followed by a blank line, then save the file to remove the linter warning.

---

Nitpick comments:
In `@docs/steering/meeting-notes/2026-03-02.md`:
- Line 44: Update the checklist item text to hyphenate “blog-style page”:
replace the phrase "a blog style page for announcements etc. on the website." in
the meeting note line containing "Gerald to check for a blog style page for
announcements etc. on the website. (Jakob & Gerald to plan)" with "a blog-style
page for announcements etc. on the website." so it reads with the correct
hyphenation.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 102bf597-9045-4018-a92d-1eeba578a1f6

📥 Commits

Reviewing files that changed from the base of the PR and between 9babdb1 and 0adc042.

📒 Files selected for processing (21)
  • .env
  • .github/config/.markdownlint-cli2.yaml
  • .github/workflows/markdown.yml
  • CONTRIBUTING.md
  • RELEASE_PROCESS.md
  • cli/docs/reference/.markdownlint-cli2.yaml
  • conformance/README.md
  • conformance/scenarios/sovereign/README.md
  • docs/adr/0012_construct_as_transformation.md
  • docs/adr/0013_sovereign_cloud_reference_scenario.md
  • docs/adr/0014_conformance_test_suite.md
  • docs/community/README.md
  • docs/steering/GOVERNANCE.md
  • docs/steering/meeting-notes/2025-11-03.md
  • docs/steering/meeting-notes/2025-12-01.md
  • docs/steering/meeting-notes/2026-01-05.md
  • docs/steering/meeting-notes/2026-02-02.md
  • docs/steering/meeting-notes/2026-03-02.md
  • docs/steering/meeting-notes/2026-04-07.md
  • docs/steering/meeting-notes/2026-05-04.md
  • tools.Taskfile.yml
✅ Files skipped from review due to trivial changes (14)
  • conformance/README.md
  • docs/steering/GOVERNANCE.md
  • docs/community/README.md
  • cli/docs/reference/.markdownlint-cli2.yaml
  • conformance/scenarios/sovereign/README.md
  • .github/config/.markdownlint-cli2.yaml
  • docs/adr/0014_conformance_test_suite.md
  • CONTRIBUTING.md
  • docs/steering/meeting-notes/2026-01-05.md
  • docs/steering/meeting-notes/2026-05-04.md
  • docs/steering/meeting-notes/2025-11-03.md
  • docs/adr/0013_sovereign_cloud_reference_scenario.md
  • docs/steering/meeting-notes/2026-04-07.md
  • RELEASE_PROCESS.md
🚧 Files skipped from review as they are similar to previous changes (2)
  • tools.Taskfile.yml
  • docs/adr/0012_construct_as_transformation.md

jakobmoellerdev and others added 7 commits April 10, 2026 17:55
- Add lint job to markdown.yml using npx markdownlint-cli2 (respects per-directory configs)
- Add markdownlint task to tools.Taskfile.yml using npx markdownlint-cli2
- Ignore auto-generated kubernetes/controller/chart/README.md from linting
- Disable MD060 in root markdownlint config
- Disable MD032 in cli/docs/reference markdownlint config
- Fix all markdownlint violations across the repo (auto-fix + manual)
- Fix MD040 in conformance/scenarios/sovereign/README.md and RELEASE_PROCESS.md

Signed-off-by: Jakob Möller <contact@jakob-moeller.com>
- Remove unused MARKDOWNLINT_CLI2_TARGET_VERSION variable (MARKDOWNLINT_CLI2_VERSION not in .env)
- Add comment explaining why MD032 is disabled in cli/docs/reference config
- Align CI workflow argument order with local Taskfile (--config before glob)

Signed-off-by: Jakob Möller <jakob.moeller@sap.com>
- Wrap bare URLs in angle brackets (MD034)
- Fix list indentation to use 2-space increments (MD007)
- Remove extra blank lines (MD012)
- Add trailing newline (MD047)

Signed-off-by: Jakob Möller <jakob.moeller@sap.com>
- Add MARKDOWNLINT_CLI2_VERSION=0.22.0 to .env (with Renovate annotation)
- Add MARKDOWNLINT_CLI2_TARGET_VERSION var to Taskfile referencing .env value
- Pin npx invocation to the versioned var in both Taskfile and CI workflow
- Read version from .env in CI via `source .env` pattern (consistent with ci.yml)
- Add actions/setup-node step before linter run for consistency with other Node jobs

Signed-off-by: Jakob Möller <jakob.moeller@sap.com>
website/ has its own config (.github/config/website.markdownlint-cli2.yaml)
and dedicated workflow (website-verify-markdown.yml), so it should not be
linted by the general markdownlint job.

Signed-off-by: Jakob Möller <jakob.moeller@sap.com>
website/ has its own spellcheck config and workflow (website-verify-markdown.yml),
so it should not be checked by the general spellcheck job.

Signed-off-by: Jakob Möller <jakob.moeller@sap.com>
Add technical terms from website/ content that were flagged as misspelled:
auditable, autoscaler, callout, CET, cryptographically, Diataxis, Docker's,
dockermulti, filesystems, frontend, frontmatter, Fulcio, hasMermaid, linkTitle,
MediaType's, microservice/microservices, Namespaced, nerdctl, ocmv, OpenSSL,
prem, renderer, shortcodes, src, subheadline, svg, Terraform, webshop, WSL,
Contributability, Misattributed

Signed-off-by: Jakob Möller <jakob.moeller@sap.com>
Comment thread .github/workflows/markdown.yml
@jakobmoellerdev jakobmoellerdev merged commit fb0ee53 into open-component-model:main Apr 10, 2026
67 checks passed
morri-son pushed a commit to morri-son/open-component-model that referenced this pull request Apr 14, 2026
…n-component-model#1753)

<!-- markdownlint-disable MD041 -->
#### What this PR does / why we need it

- Add `lint` job to `markdown.yml` workflow using `task
tools:markdownlint`
- Add `markdownlint` and `markdownlint/install` tasks to
`tools.Taskfile.yml` with version management

#### Which issue(s) this PR fixes
<!--
Usage: `Fixes #<issue number>`, or `Fixes (paste link of issue)`.
-->

runs automatic linting and gives a task to fix that linting.

---------

Signed-off-by: Jakob Möller <contact@jakob-moeller.com>
Signed-off-by: Jakob Möller <jakob.moeller@sap.com>

Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>
morri-son pushed a commit to morri-son/open-component-model that referenced this pull request Apr 15, 2026
…n-component-model#1753)

<!-- markdownlint-disable MD041 -->
#### What this PR does / why we need it

- Add `lint` job to `markdown.yml` workflow using `task
tools:markdownlint`
- Add `markdownlint` and `markdownlint/install` tasks to
`tools.Taskfile.yml` with version management

#### Which issue(s) this PR fixes
<!--
Usage: `Fixes #<issue number>`, or `Fixes (paste link of issue)`.
-->

runs automatic linting and gives a task to fix that linting.

---------

Signed-off-by: Jakob Möller <contact@jakob-moeller.com>
Signed-off-by: Jakob Möller <jakob.moeller@sap.com>
Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/documentation Documentation related component/github-actions Changes on GitHub Actions or within `.github/` directory kind/chore chore, maintenance, etc. size/m Medium

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants