Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(doc): add github action to check markdown links #361

Merged
merged 1 commit into from
Dec 18, 2024

Conversation

jonperron
Copy link
Contributor

@jonperron jonperron commented Dec 18, 2024

Fix #359

Changes

  • Add github action to check markdown links in documentation

Additional info

According to github, this workflow will have to be setup in the branch protections rules if we want it to be not mandatory for merge.

I have not found a "mandatory" keyword in https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions

Tests

Tested in jonperron#1

@jonperron
Copy link
Contributor Author

Let's wait for #360 to be merged, the current workflow identify issues and will be blocking if enabled.

@da-ekchajzer
Copy link
Collaborator

Thank you for your contribution. Can we limit workflow execution only when a change is made to the /docs/ folder?

    paths:
      - 'docs/**'

* Only planned to run on push and pull request on main

boaviztapi-359
@jonperron
Copy link
Contributor Author

Updated following your feedback @da-ekchajzer 👍

@da-ekchajzer
Copy link
Collaborator

Works for me thank you very much !

@da-ekchajzer da-ekchajzer merged commit b2a2024 into Boavizta:main Dec 18, 2024
@jonperron jonperron deleted the fix/boaviztapi-359 branch December 18, 2024 15:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a link checker when publishing documentation
2 participants