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

Add tests for the starter pack #261

Merged

Conversation

ru-fu
Copy link
Contributor

@ru-fu ru-fu commented Jul 24, 2024

This PR adds a general test for the init script, running it both with "." and with "docs" as installation folder and making sure that both the build and the checks run without errors.

In addition, it adds some test files that we can use to test the starter pack functionality. For now, I've only included related links and Discourse links, mainly to show how these tests can be implemented.

@ru-fu ru-fu force-pushed the DOCPR-649-init-tests branch 10 times, most recently from 057a229 to dbd578b Compare July 24, 2024 10:56
@ru-fu ru-fu marked this pull request as ready for review July 24, 2024 11:00
@ru-fu ru-fu force-pushed the DOCPR-649-init-tests branch 7 times, most recently from f59484b to dc6dc3c Compare August 6, 2024 15:33
Copy link
Collaborator

@SecondSkoll SecondSkoll left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Minor suggestion below.

@@ -0,0 +1,64 @@
name: Test starter pack
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion: Add a comment to indicate this is intended just for testing the starter pack itself.

I believe a lot of teams clone the starter pack instead of using the init script, so this might help to prevent them from running these checks unnecessarily.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense - but if teams keep cloning the starter pack in the future, they will be in a lot of trouble, so we should REALLY tell them not to do this.

ru-fu and others added 4 commits August 12, 2024 14:49
update to cover the vocab rules
Needed to work around
canonical/canonical-sphinx#34

Signed-off-by: Ruth Fuchss <[email protected]>
Add some files that we can use to test the functionality.

Signed-off-by: Ruth Fuchss <[email protected]>
@ru-fu
Copy link
Contributor Author

ru-fu commented Aug 12, 2024

Expected to fail now since it's pulling the init script from use-canonical-sphinx-extensions and not this branch - should work again after merging.

@ru-fu ru-fu merged commit 27312b4 into canonical:use-canonical-sphinx-extension Aug 12, 2024
2 of 4 checks passed
@ru-fu ru-fu deleted the DOCPR-649-init-tests branch August 12, 2024 12:51
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.

3 participants