Skip to content

Commit d41f8a0

Browse files
Add documentation for NightlyTestManual
1 parent 1279554 commit d41f8a0

File tree

4 files changed

+12
-0
lines changed

4 files changed

+12
-0
lines changed

README.developers.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -301,6 +301,18 @@ For the very large runs, you can submit your runs on a large cluster. A template
301301
a Slurm-managed cluster can be found under vtr_flow/tasks/slurm/
302302

303303
## Continuous integration (CI)
304+
305+
### Manual Nightly Tests
306+
307+
You can use remote servers to run the [vtr_reg_nightly_test1-7](#vtr_reg_nightly_test1-N) tests. These tests are triggered manually by going to the GitHub Actions menu, selecting the NightlyTestManual workflow and selecting run workflow. Once you do that, the [Nightly Test Manual Workflow](https://github.com/verilog-to-routing/vtr-verilog-to-routing/blob/master/.github/workflows/nightly_test_manual.yml) will be triggered. This run will take approximately 15 hours to complete and will cancel any currently running workflows.
308+
309+
<img src="https://raw.githubusercontent.com/verilog-to-routing/vtr-verilog-to-routing/master/doc/src/dev/run_ci_manual/select_actions.png" alt="Select GitHub Actions menu" width="60%"/>
310+
<br/>
311+
<img src="https://raw.githubusercontent.com/verilog-to-routing/vtr-verilog-to-routing/master/doc/src/dev/run_ci_manual/select_workflow.png" alt="Select the NightlyTestManual workflow" width="30%"/>
312+
<img src="https://raw.githubusercontent.com/verilog-to-routing/vtr-verilog-to-routing/master/doc/src/dev/run_ci_manual/run_workflow.png" alt="Run the Workflow" width="30%"/>
313+
314+
### Other CI Tests
315+
304316
For the following tests, you can use remote servers instead of running them locally. Once the changes are pushed into the
305317
remote repository, or a PR is created, the [Test Workflow](https://github.com/verilog-to-routing/vtr-verilog-to-routing/blob/master/.github/workflows/test.yml)
306318
will be triggered. Many tests are included in the workflow, including:
53.5 KB
Loading
117 KB
Loading
52.5 KB
Loading

0 commit comments

Comments
 (0)