diff --git a/_docs/developer/testing/autograding_integration_tests.md b/_docs/developer/testing/autograding_integration_tests.md index ea1acdd6..1d517700 100644 --- a/_docs/developer/testing/autograding_integration_tests.md +++ b/_docs/developer/testing/autograding_integration_tests.md @@ -1,6 +1,6 @@ --- title: Autograding Tests -category: Developer +category: Developer > Development Instructions > Continuous Integration Testing --- _NOTE: Currently, these tests can only be run from within Vagrant._ diff --git a/_docs/developer/testing/cypress.md b/_docs/developer/testing/cypress.md index 9947a64f..d4418acf 100644 --- a/_docs/developer/testing/cypress.md +++ b/_docs/developer/testing/cypress.md @@ -1,5 +1,6 @@ --- title: End-to-End testing with Cypress +category: Developer > Development Instructions > Continuous Integration Testing --- The _End-to-End Testing_ (e2e) suite utilizes [Cypress](https://www.cypress.io/), diff --git a/_docs/developer/testing/external_contributors.md b/_docs/developer/testing/external_contributors.md new file mode 100644 index 00000000..048bea9f --- /dev/null +++ b/_docs/developer/testing/external_contributors.md @@ -0,0 +1,26 @@ +--- +title: External Contributors +category: Developer > Development Instructions > Continuous Integration Testing +--- + +To run all Submitty workflows on a forked repository, you must manually trigger the workflow. This is because GitHub Actions do not run on forked repositories by default. One of the people in the Submitty organization must manually trigger the workflow for you. To avoid this, you can trust the workflow in your forked repository. This will allow GitHub Actions to run on your forked repository without manual intervention. + +--- + +## Steps for External Contributors + +1. The first step is to visit [https://github.com/GITHUB_USERNAME/Submitty/actions](https://github.com/GITHUB_USERNAME/Submitty/actions) (or click the actions tab from your forked submitty repository) and click on the button labeled "I understand my workflows, go ahead and enable them". + ![GitHub UI to trust workflows in fork](/images/testing/fork_trust.png) + +2. After that, on the left side of the page, click on the workflow labeled "CI" to be able to run the workflow. Then, in the "Run workflow" dropdown, select the branch you want to run the workflow on and click the green "Run workflow" button. + ![GitHub UI to manually trigger workflow](/images/testing/fork_dispatch.png) +3. Congratulations! You have successfully triggered the workflow on your forked repository. You should now see a new started workflow in the list of workflows. + ![GitHub UI to view workflow run](/images/testing/fork_workflow_run.png) + +--- + +These steps are drawn from: + +[https://github.com/github/docs/issues/15761](https://github.com/github/docs/issues/15761) + +[https://docs.github.com/en/actions/managing-workflow-runs-and-deployments/managing-workflow-runs/manually-running-a-workflow](https://docs.github.com/en/actions/managing-workflow-runs-and-deployments/managing-workflow-runs/manually-running-a-workflow) diff --git a/_docs/developer/testing/github_actions.md b/_docs/developer/testing/github_actions.md index aefe6da0..384f4da6 100644 --- a/_docs/developer/testing/github_actions.md +++ b/_docs/developer/testing/github_actions.md @@ -1,5 +1,6 @@ --- title: GitHub Actions +category: Developer > Development Instructions > Continuous Integration Testing --- We utilize [GitHub actions](https://docs.github.com/en/actions) to enable *continuous integration* diff --git a/_docs/developer/testing/index.md b/_docs/developer/testing/index.md index 2803be67..b0018080 100644 --- a/_docs/developer/testing/index.md +++ b/_docs/developer/testing/index.md @@ -1,5 +1,6 @@ --- -title: Testing +title: Continuous Integration Testing +category: Developer > Development Instructions --- To verify expected behavior of Submitty, we use diff --git a/_docs/developer/testing/install_php.md b/_docs/developer/testing/install_php.md index b0b58ca7..7181fb33 100644 --- a/_docs/developer/testing/install_php.md +++ b/_docs/developer/testing/install_php.md @@ -1,5 +1,6 @@ --- title: Install PHP +category: Developer > Development Instructions > Continuous Integration Testing --- In order to run the PHP Linter, Static Analysis, and PHPUnit tests locally diff --git a/_docs/developer/testing/linting_static_analysis.md b/_docs/developer/testing/linting_static_analysis.md index 461237ee..ff33e992 100644 --- a/_docs/developer/testing/linting_static_analysis.md +++ b/_docs/developer/testing/linting_static_analysis.md @@ -1,5 +1,6 @@ --- title: Linting / Static Analysis +category: Developer > Development Instructions > Continuous Integration Testing --- To ensure the [Coding Standards](/developer/coding_style_guide) of Submitty, we use a mixture diff --git a/_docs/developer/testing/php_unit_tests.md b/_docs/developer/testing/php_unit_tests.md index 7ef0bcdf..56da8544 100644 --- a/_docs/developer/testing/php_unit_tests.md +++ b/_docs/developer/testing/php_unit_tests.md @@ -1,5 +1,6 @@ --- title: PHP Unit Tests +category: Developer > Development Instructions > Continuous Integration Testing --- To validate the unit behavior of the site code, we utilize diff --git a/_docs/developer/testing/python_unit_tests.md b/_docs/developer/testing/python_unit_tests.md index 3dc2de07..b3d19432 100644 --- a/_docs/developer/testing/python_unit_tests.md +++ b/_docs/developer/testing/python_unit_tests.md @@ -1,5 +1,6 @@ --- title: Python Unit Tests +category: Developer > Development Instructions > Continuous Integration Testing --- The following Python modules of Submitty are unit tested: diff --git a/images/testing/fork_dispatch.png b/images/testing/fork_dispatch.png new file mode 100644 index 00000000..630fe5c1 Binary files /dev/null and b/images/testing/fork_dispatch.png differ diff --git a/images/testing/fork_trust.png b/images/testing/fork_trust.png new file mode 100644 index 00000000..9d6cb1aa Binary files /dev/null and b/images/testing/fork_trust.png differ diff --git a/images/testing/fork_workflow_run.png b/images/testing/fork_workflow_run.png new file mode 100644 index 00000000..9cd5103a Binary files /dev/null and b/images/testing/fork_workflow_run.png differ diff --git a/navtreedata.js b/navtreedata.js index 898e0785..d2bffe15 100644 --- a/navtreedata.js +++ b/navtreedata.js @@ -214,6 +214,7 @@ var NAVTREE = [ "Localization / Language Support", "/developer/development_instructions/localization", null ], [ "Continuous Integration Testing", "/developer/testing/index", [ [ "Overview", "/developer/testing/index", null ], + ["External Contributors", "/developer/testing/external_contributors", null], [ "Installing PHP", "/developer/testing/install_php", null ], [ "Linting / Static Analysis", "/developer/testing/linting_static_analysis", null ], [ "Python Unit Tests", "/developer/testing/python_unit_tests", null ],