Skip to content

Add docs link verification task#857

Open
alvarosanchez wants to merge 1 commit into
8.1.xfrom
DEV-125-create-gradle-task-to-verify-links-in-index-html-and-configurationreference-html-are-not-broken
Open

Add docs link verification task#857
alvarosanchez wants to merge 1 commit into
8.1.xfrom
DEV-125-create-gradle-task-to-verify-links-in-index-html-and-configurationreference-html-are-not-broken

Conversation

@alvarosanchez

@alvarosanchez alvarosanchez commented Apr 27, 2026

Copy link
Copy Markdown
Member

Summary

  • Add a checkDocsLinks Gradle task for Micronaut docs projects.
  • Validate local file and fragment links in generated index.html and configurationreference.html.
  • Keep docs unchanged so CI can invoke link checking explicitly.

Verification

  • ./gradlew :micronaut-gradle-plugins:test --tests io.micronaut.build.docs.ValidateGuideLinksTaskSpec
  • ./gradlew :micronaut-gradle-plugins:functionalTest --tests io.micronaut.build.docs.DocsLinksFunctionalTest
  • git diff --check origin/HEAD...HEAD

Closes #181


✨ This message was AI-generated using gpt-5.5

Copilot AI review requested due to automatic review settings April 27, 2026 15:10
@alvarosanchez alvarosanchez added the type: enhancement New feature or request label Apr 27, 2026

Copilot AI 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.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@alvarosanchez

Copy link
Copy Markdown
Member Author

@sdelamo did you want to validate external links when you created #181? Because this PR is not checking that

@alvarosanchez alvarosanchez requested review from sdelamo May 4, 2026 13:14
@alvarosanchez alvarosanchez changed the base branch from 8.0.x to 8.1.x May 21, 2026 10:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type: enhancement New feature or request

Projects

Status: Backlog

Development

Successfully merging this pull request may close these issues.

Create Gradle task to verify links in index.html and configurationreference.html are not broken

3 participants