Skip to content

Commit 3b4ea7e

Browse files
committed
[Documentation] Add guide for external contributors to trigger workflows
1 parent 7f95e83 commit 3b4ea7e

File tree

5 files changed

+26
-0
lines changed

5 files changed

+26
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: External Contributors
3+
---
4+
5+
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.
6+
7+
---
8+
9+
## Steps for External Contributors
10+
11+
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".
12+
![GitHub UI to trust workflows in fork](/images/fork_trust.png)
13+
14+
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.
15+
![GitHub UI to manually trigger workflow](/images/fork_dispatch.png)
16+
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.
17+
![GitHub UI to view workflow run](/images/fork_workflow_run.png)
18+
19+
---
20+
21+
These steps are drawn from:
22+
23+
[https://github.com/github/docs/issues/15761](https://github.com/github/docs/issues/15761)
24+
25+
[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)

images/fork_dispatch.png

564 KB
Loading

images/fork_trust.png

393 KB
Loading

images/fork_workflow_run.png

493 KB
Loading

navtreedata.js

+1
Original file line numberDiff line numberDiff line change
@@ -214,6 +214,7 @@ var NAVTREE =
214214
[ "Localization / Language Support", "/developer/development_instructions/localization", null ],
215215
[ "Continuous Integration Testing", "/developer/testing/index", [
216216
[ "Overview", "/developer/testing/index", null ],
217+
["External Contributors", "/developer/testing/external_contributors", null],
217218
[ "Installing PHP", "/developer/testing/install_php", null ],
218219
[ "Linting / Static Analysis", "/developer/testing/linting_static_analysis", null ],
219220
[ "Python Unit Tests", "/developer/testing/python_unit_tests", null ],

0 commit comments

Comments
 (0)