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

PR validation of documentation is lacking #4267

Closed
theunrepentantgeek opened this issue Sep 15, 2024 · 1 comment
Closed

PR validation of documentation is lacking #4267

theunrepentantgeek opened this issue Sep 15, 2024 · 1 comment
Assignees
Labels
bug 🪲 Something isn't working

Comments

@theunrepentantgeek
Copy link
Member

Describe the bug

We managed to merge PR #4261 without catching a syntax error in a relref expression.

Expected behavior

Our CI checks should have caught it.

@theunrepentantgeek
Copy link
Member Author

Catch 22:
If we make the Validate Documentation Links action mandatory, we can end up blocked when a PR both adds new pages to our docs and references those pages.
If we retain Validate Documentation Links as optional (the current state), then we can merge broken documentation changes.

Since these are easy to fix, we'll retain the current stage, but with a reminder to all core contributors to check the status of this action explicitly before hitting merge.

@github-project-automation github-project-automation bot moved this from Backlog to Recently Completed in Azure Service Operator Roadmap Sep 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug 🪲 Something isn't working
Projects
Development

No branches or pull requests

2 participants