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.

Sign up for GitHub

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

Jump to bottom

Build system: validate that documentation doesn't have any errors or warnings during PR validation #5528

Closed
Aaronontheweb opened this issue Jan 22, 2022 · 1 comment · Fixed by #5542
Closed

Build system: validate that documentation doesn't have any errors or warnings during PR validation #5528

Aaronontheweb opened this issue Jan 22, 2022 · 1 comment · Fixed by #5542
Labels
build system docs
Milestone
1.4.34

Comments

@Aaronontheweb
Copy link
Member

To help ensure clean DocFx hygiene, we need to ensure that we're not leaving behind broken links or other issues such as #5527, which was introduced when we changed #5500. Therefore, I think the build system needs to flag this by building the website upon every single pull request since merges into dev usually trigger website updates.

We can manually authorize this stage to determine if it's needed for a particular PR, but we need some automation to check against this.
@Aaronontheweb
Copy link
Member Author

Another PR we wouldn't have had to made if we had this: #5532 (review)

@Aaronontheweb Aaronontheweb mentioned this issue Jan 26, 2022
Merged
@Aaronontheweb Aaronontheweb added this to the 1.4.34 milestone Feb 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
build system docs
Projects
None yet
Milestone
1.4.34
Development

Successfully merging a pull request may close this issue.

Check for possible broken documentation by failing on DocFX warning Arkatufus/akka.net
1 participant
@Aaronontheweb