Skip to content

markdown lint#9389

Merged
eerhardt merged 1 commit intodotnet:mainfrom
danmoseley:markdown
May 19, 2025
Merged

markdown lint#9389
eerhardt merged 1 commit intodotnet:mainfrom
danmoseley:markdown

Conversation

@danmoseley
Copy link
Member

@danmoseley danmoseley commented May 19, 2025

Description

Fix these issues, and pin markdownlint so new rules don't appear out of the blue again.

dan@danmose50:/mnt/c/git/aspire$ markdownlint --ignore '.dotnet/' --ignore '**/AnalyzerReleases.*.md' '**/*.md'
README.md:20:252 MD059/descriptive-link-text Link text should be descriptive [Context: "[here]"]
README.md:20:314 MD059/descriptive-link-text Link text should be descriptive [Context: "[here]"]
src/Aspire.Dashboard/README.md:133:85 MD059/descriptive-link-text Link text should be descriptive [Context: "[here]"]
src/Components/Aspire_Components_Progress.md:53:551 MD059/descriptive-link-text Link text should be descriptive [Context: "[here]"]
src/Components/Aspire_Components_Progress.md:65:172 MD059/descriptive-link-text Link text should be descriptive [Context: "[here]"]

Checklist

  • Is this feature complete?
    • Yes. Ready to ship.
    • No. Follow-up changes expected.
  • Are you including unit tests for the changes and scenario tests if relevant?
    • Yes
    • No
  • Did you add public API?
    • Yes
      • If yes, did you have an API Review for it?
        • Yes
        • No
      • Did you add <remarks /> and <code /> elements on your triple slash comments?
        • Yes
        • No
    • No
  • Does the change make any security assumptions or guarantees?
    • Yes
      • If yes, have you done a threat model and had a security review?
        • Yes
        • No
    • No
  • Does the change require an update in our Aspire docs?

Copilot AI review requested due to automatic review settings May 19, 2025 13:47
Copilot AI reviewed May 19, 2025
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR addresses markdown lint issues by updating link texts to be more descriptive and pins the markdownlint-cli version to 0.45.0 so that future rule changes do not unexpectedly affect builds.

  • Updated descriptive link texts in several markdown files (README.md, Aspire.Dashboard/README.md, and Aspire_Components_Progress.md) to resolve MD059 errors.
  • Pinned markdownlint-cli to a specific version in the GitHub Actions workflow.

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File Description
src/Components/Aspire_Components_Progress.md Revised link text to provide a clear reference to a README example.
src/Aspire.Dashboard/README.md Updated telemetry documentation link text to be more descriptive.
README.md Improved labelling of sample references with more descriptive link texts.
.github/workflows/markdownlint.yml Explicitly set markdownlint-cli version to 0.45.0 to pin linting behavior.

@github-actions github-actions bot added the area-integrations Issues pertaining to Aspire Integrations packages label May 19, 2025
@eerhardt eerhardt merged commit 1b76ab9 into dotnet:main May 19, 2025
252 of 253 checks passed
@danmoseley danmoseley deleted the markdown branch May 19, 2025 14:31
danmoseley added a commit to danmoseley/aspire that referenced this pull request May 27, 2025
@danmoseley
markdown lint (dotnet#9389)
8cbc2e1 
Fix these issues, and pin markdownlint so new rules don't appear out of the blue again.
wtgodbe pushed a commit that referenced this pull request May 28, 2025
@danmoseley
markdown lint (#9389) (#9536)
dcbd3d9 
Fix these issues, and pin markdownlint so new rules don't appear out of the blue again.
@github-actions github-actions bot locked and limited conversation to collaborators Jun 19, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

Copilot code review Copilot Copilot left review comments

@davidfowl davidfowl davidfowl approved these changes

@eerhardt eerhardt eerhardt approved these changes

@radical radical Awaiting requested review from radical radical is a code owner

@sebastienros sebastienros Awaiting requested review from sebastienros sebastienros is a code owner

Assignees

No one assigned

Labels

area-integrations Issues pertaining to Aspire Integrations packages

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@danmoseley @davidfowl @eerhardt