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

Test if the docs are built successfully when something inside docs/ is modified #172

Open
niketagrawal opened this issue Nov 14, 2023 · 0 comments
Assignees
Labels

Comments

@niketagrawal
Copy link
Collaborator

niketagrawal commented Nov 14, 2023

When new changes are introduced to main via a feature branch using a pull request, tests are run automatically on the feature branch to ensure that the code changes do not break the existing functionality of aeolis. While there are no specific tests for the docs like the rest of the code, the docs are expected to build successfully every time anything inside the directory docs/ is modified.

This docs build test can be setup to run automatically on pull requests to main when there is a change inside docs/ using a separate GitHub actions workflow.

@niketagrawal niketagrawal self-assigned this Nov 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant