Skip to content

Conversation

Mpdreamz
Copy link
Member

@Mpdreamz Mpdreamz commented Feb 24, 2025

Adds two commands to docs-assembler

$ docs-assembler link validate-inbound-all

and

$ docs-assembler link validate-inbound-local

validate-inbound-all

Validates all repositories published to the link index. Each links.json has cross_links section declaring all cross links used in that docset. This command will validate each cross link actually still resolves.

validate-inbound-local

Similarly this validates all published cross_links still resolve using a local links.json file to override the definition for a given repository.

This is exposed as a github action:

    - name: Validate Inbound Links
      uses: elastic/docs-builder/actions/validate-inbound-local@main

Which may be called after a documentation build. Will hook this up to be part of the default publish flow in a follow up PR.

This will only validate crosslinks to the current repository. So a failure in one repository shouldn't fail all repositories.

@Mpdreamz Mpdreamz self-assigned this Feb 24, 2025
@Mpdreamz Mpdreamz requested a review from a team February 24, 2025 12:28
@Mpdreamz Mpdreamz linked an issue Feb 24, 2025 that may be closed by this pull request
3 tasks
Copy link
Member

@reakaleek reakaleek left a comment

Choose a reason for hiding this comment

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

🚀 as always

@Mpdreamz Mpdreamz merged commit 67ec691 into main Feb 24, 2025
5 checks passed
@Mpdreamz Mpdreamz deleted the feature/inbound-link-checker branch February 24, 2025 14:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Cross-repo link checking not working as expected
2 participants