Commit ac38d456 authored by Russell Dickenson's avatar Russell Dickenson

Merge branch '299215-fix-documentation-examples' into 'master'

Enhance Scan Policies examples in documentation to match implementation

See merge request gitlab-org/gitlab!59736
parents 44f763a8 8530dd6d
...@@ -66,7 +66,8 @@ scan_execution_policy: ...@@ -66,7 +66,8 @@ scan_execution_policy:
enabled: true enabled: true
rules: rules:
- type: pipeline - type: pipeline
branch: master branches:
- master
actions: actions:
- scan: dast - scan: dast
scanner_profile: Scanner Profile A scanner_profile: Scanner Profile A
...@@ -76,7 +77,8 @@ scan_execution_policy: ...@@ -76,7 +77,8 @@ scan_execution_policy:
enabled: true enabled: true
rules: rules:
- type: pipeline - type: pipeline
branch: main branches:
- main
actions: actions:
- scan: dast - scan: dast
scanner_profile: Scanner Profile C scanner_profile: Scanner Profile C
...@@ -108,7 +110,7 @@ This rule enforces the defined actions whenever the pipeline runs for a selected ...@@ -108,7 +110,7 @@ This rule enforces the defined actions whenever the pipeline runs for a selected
| Field | Type | Possible values | Description | | Field | Type | Possible values | Description |
|-------|------|-----------------|-------------| |-------|------|-----------------|-------------|
| `type` | `string` | `pipeline` | The rule's type. | | `type` | `string` | `pipeline` | The rule's type. |
| `branch` | `string` | `*` or the branch's name | The branch the given policy applies to (supports wildcard). | | `branches` | `array` of `string` | `*` or the branch's name | The branch the given policy applies to (supports wildcard). |
### `scan` action type ### `scan` action type
...@@ -140,7 +142,8 @@ scan_execution_policy: ...@@ -140,7 +142,8 @@ scan_execution_policy:
enabled: true enabled: true
rules: rules:
- type: pipeline - type: pipeline
branch: release/* branches:
- release/*
actions: actions:
- scan: dast - scan: dast
scanner_profile: Scanner Profile A scanner_profile: Scanner Profile A
...@@ -150,7 +153,8 @@ scan_execution_policy: ...@@ -150,7 +153,8 @@ scan_execution_policy:
enabled: true enabled: true
rules: rules:
- type: pipeline - type: pipeline
branch: main branches:
- main
actions: actions:
- scan: dast - scan: dast
scanner_profile: Scanner Profile C scanner_profile: Scanner Profile C
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment