Skip to content

Commit

Permalink
Update eng_sys_checks to highlight the queue time options for skippin…
Browse files Browse the repository at this point in the history
…g tox (#17816)

* update the documentation to show the skip methodology
  • Loading branch information
scbedd authored Apr 6, 2021
1 parent a555acd commit b20bcbf
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions doc/eng_sys_checks.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,21 @@ Example PR build:
- `Analyze` tox envs run during the `Analyze job.
- `Test <platform>_<pyversion>` runs PR/Nightly tox envs, depending on context.

## Skipping a tox test environment at queue time

All build definitions allow choice at queue time as to which `tox` environments actually run during the test phase.

1. Find your target service `internal` build.
2. Click `Run New`
3. Before clicking `run` against `master` or your target commit, click `Variables` and add a variable. The value should be a comma separated list of tox environments that you want to run in the test phase.
4. Once it's set, run the build!

This is an example setting of that narrows the default set from `whl, sdist, depends, latestdependency, minimumdependency`.

![res/queue_time_variable.png](res/queue_time_variable.png)

Any combination of valid valid tox environments will work. Reference either this document or the file present at `eng/tox/tox.ini` to find what options are available.

## Analyze Checks
Analyze job in both nightly CI and pull request validation pipeline runs a set of static analysis using external and internal tools. Following are the list of these static analysis.

Expand Down
Binary file added doc/res/queue_time_variable.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b20bcbf

Please sign in to comment.