GitHub Continuous Integration - BrentBaccala/Singular GitHub Wiki

Singular is configured to use GitHub Actions, GitHub's continuous integration system, to run the Singular test suite on GitHub servers.

The configuration is mostly in the .github subdirectory; see GitHub's Actions documentation for more information.

Any pull request submitted to the main Singular repository will trigger a run of the test suite.

Any additional commits pushed to an existing pull request will trigger another test run.

To run the test suite on your own GitHub branch, do this:

1. log into GitHub
2. if you haven't done so already, navigate to the Singular repository and create your own forked copy by clicking on the Fork button
3. push the code you want tested to a branch of your forked copy of Singular
4. navigate to your forked copy of Singular and click on Actions
5. click on Run tests
6. click on the Run workflow pulldown menu, select the branch you want to run the tests on, then click on Run workflow
7. the new workflow run will appear on the list of workflow runs; click on it to observe it while running

If the test suite fails, the workflow log will likely provide an explanation for why. If it's not clear why tests are failing, an option is available when running the workflow to start an ssh server on the test runner. In this case, at the end of the test run, a DNS name will be printed on the log which can be used to connect to the test runner and examine it. Selecting this option adds an additional ten minute delay to the end of the test run, to give you a suitable opportunity to connect.