Adds a test to CI to build OpenTurbine through Spack and then build/run our documentation tests #341
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ddement
force-pushed
the
test_install
branch
3 times, most recently
from
ba04273 to
0df6d9a
Compare
…un our documentation tests This test only runs when we push to main, because it builds everything from scratch as one would do when actually installing OpenTurbine. It serves as a test for our CMake install capabilities and our Spack script and as a practical demonstration of how to set up a development environment through Spack. This PR adds a new classification of tests: documentation tests. These tests will have their own CMake scripts and should have extensive comments such that users can learn how to use OpenTurbine from reading these tests. This first one just mirrors our Floating Platform regression test, but we should add more as we introduce more capabilities to our external interface. The comments in there are fine for now, but could be fleshed out even further to explain the workflow even further.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This test only runs when we push to main, because it builds everything from scratch as one would do when actually installing OpenTurbine. It serves as a test for our CMake install capabilities and our Spack script and as a practical demonstration of how to set up a development environment through Spack.
This PR adds a new classification of tests: documentation tests. These tests will have their own CMake scripts and should have extensive comments such that users can learn how to use OpenTurbine from reading these tests. This first one just mirrors our Floating Platform regression test, but we should add more as we introduce more capabilities to our external interface. The comments in there are fine for now, but could be fleshed out even further to explain the workflow even further.