Skip to content

Commit

Permalink
Revert swap in previous commit, and move another sentence for better …
Browse files Browse the repository at this point in the history
…flow.
  • Loading branch information
stephengillie committed Feb 8, 2024
1 parent 415c454 commit c4c427b
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions Tools/ManualValidationPipeline.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,11 @@ The Review.csv file is a CSV as named, with 3 columns: PackageIdentifier, Note,

## Word Filter List

The Word Filter List began as a way to catch EULA and other license agreement installer switches, and has expanded as a way to prevent scripted applications and specific hosts. (To-do - currently a variable in the PS1 file.)
The Word Filter List began as a way to catch EULA and other license agreement installer switches, and has expanded as a way to prevent scripted applications and specific hosts.

### Data structure

The WordFilterList.txt file is a plain text file, interpreted as an array of strings.
The WordFilterList.txt file is a plain text file, interpreted as an array of strings. (To-do - currently a variable in the PS1 file.)

## Addition and Removal

Expand All @@ -68,18 +68,18 @@ Validation ususally proceeds in this way:
1. Automatic Validation Pipeline performs analysis of manifest and URLs, then automated install of package in a VM. Any errors in this step will add an error label to the PR. If no errors, proceed to step 7.
1. Error label applied to PR.
1. An hourly scripted process will extract the error from the validation run logs and add to the PR comments.
1. If no errors, and the package is on the auto-waiver list (described below) then the PR gets a waiver.
1. For Defender errors, it will retry after an 18-hour break. This should be long enough to allow Defender teams to update signatures and clear false positives, and short enough to minimize blocking.
1. Some other specific types of PR have special handling.
- If no errors, and the package is on the auto-waiver list (described below) then the PR gets a waiver.
- For Defender errors, it will retry after an 18-hour break. This should be long enough to allow Defender teams to update signatures and clear false positives, and short enough to minimize blocking.
- Some other specific types of PR have special handling.
1. Remediation of errant PRs.
1. Manifest errors either need a manifest update or sometimes a manifest path update. The error should be available in the comments.
1. URL and download errors can sometimes be fixed through removing the URL from the manifest, if it's not an `InstallerUrl`. If it is, then another source for the package would be needed for the PR to proceed.
1. Installer errors can sometimes be fixed by updating installer switches, or adding a dependency if the error states that one is missing.
1. Application launch and run errors can also sometimes be fixed through adding a dependency, again only if one is called for.
1. Other kinds of errors can't easliy be advanced past and might block a PR for some time.
1. If no errors, then install the manifest in a local VM 1. essentially the Manual Validation Pipeline again 1. and examine. if still no errors, then the PR gets a waiver. (Some packages, most frequently CLI and tray-based, require manual review.)
- Manifest errors either need a manifest update or sometimes a manifest path update. The error should be available in the comments.
- URL and download errors can sometimes be fixed through removing the URL from the manifest, if it's not an `InstallerUrl`. If it is, then another source for the package would be needed for the PR to proceed.
- Installer errors can sometimes be fixed by updating installer switches, or adding a dependency if the error states that one is missing.
- Application launch and run errors can also sometimes be fixed through adding a dependency, again only if one is called for.
- Other kinds of errors can't easliy be advanced past and might block a PR for some time.
- If no errors, then install the manifest in a local VM - essentially the Manual Validation Pipeline again - and examine. if still no errors, then the PR gets a waiver. (Some packages, most frequently CLI and tray-based, require manual review.)
1. After remediation, return to step 2.
1. If the issue couldn't be remediated, then the PR doesn't have a clear path and might linger for some time.
- If the issue couldn't be remediated, then the PR doesn't have a clear path and might linger for some time.
1. `Validation-Complete` label applied.
1. Moderator reviews, performs Validation Checks below, and approves if they pass.
1. Publish pipeline reviews and publishes repository into WinGet source data file.
Expand Down

0 comments on commit c4c427b

Please sign in to comment.