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 continuous integration to verify installation instructions #13

Open
Bisaloo opened this issue May 10, 2023 · 1 comment
Open

Add continuous integration to verify installation instructions #13

Bisaloo opened this issue May 10, 2023 · 1 comment

Comments

@Bisaloo
Copy link
Contributor

Bisaloo commented May 10, 2023

It is not uncommon that installation instructions are incomplete or out of date because software authors forgot they already had some system dependencies installed on their machine.

To ensure that the code compiles and that installation instructions are up-to-date, it would be helpful to add continuous integration (e.g., GitHub Actions) that try and install the software.

It's probably too difficult to go one step further and add end-to-end testing at this point because testing graphical interfaces is generally more complex than testing command line interfaces.

Please let me know if you need additional documentation or guidance on this issue.

This is part of openjournals/joss-reviews#5284.

@RussellGarwood
Copy link
Contributor

This point is appreciated - and we will keep this issue open to reasses at future releases whether we want to set this up, as per response in JOSS review:

openjournals/joss-reviews#5284 (comment)

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

No branches or pull requests

2 participants