Skip to content

Commit c8d69e0

Browse files
authored
Reduce size of CheckEnforcer PR message (Azure#25058)
* update CheckEnforcer message to link to a md file
1 parent 1b40b93 commit c8d69e0

File tree

3 files changed

+77
-73
lines changed

3 files changed

+77
-73
lines changed

.vscode/cspell.json

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -126,30 +126,33 @@
126126
{
127127
"filename": "**/sdk/network/**/*.cs",
128128
"words": [
129+
"Azfw",
130+
"Conditon",
129131
"Ddos",
130132
"ddos",
133+
"Dnat",
131134
"Dscp",
132135
"dscp",
133-
"Mbps",
134-
"Snat",
135-
"Nics",
136-
"Fqdns",
137-
"Unprepare",
138-
"Skus",
139-
"WAFV",
140136
"Eapmscha",
141137
"Eaptls",
142-
"TLSDHEDSS",
143-
"TLSDHERSA",
144-
"Dnat",
145-
"Azfw",
146-
"Vxlan",
138+
"Fqdns",
139+
"Gcmaes",
147140
"Ipconfiguration",
141+
"Mbps",
142+
"Nics",
148143
"Owasp",
149-
"Conditon",
150144
"Pfsmm",
145+
"Snat",
146+
"Skus",
151147
"Sstp",
152-
"Gcmaes"
148+
"TLSDHEDSS",
149+
"TLSDHERSA",
150+
"Unprepare",
151+
"Vmss",
152+
"vmssip",
153+
"Vnets",
154+
"Vxlan",
155+
"WAFV",
153156
]
154157
},
155158
{
@@ -173,6 +176,7 @@
173176
"words": [
174177
"Adls",
175178
"Bangla",
179+
"Beider",
176180
"Bokmaal",
177181
"Cyrl",
178182
"Decompounder",

eng/CHECKENFORCER

Lines changed: 1 addition & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -4,62 +4,4 @@ timeout: 10
44
message: >
55
This pull request is protected by [Check Enforcer](https://aka.ms/azsdk/check-enforcer).
66

7-
# What is Check Enforcer?
8-
9-
Check Enforcer helps ensure all pull requests are covered by at least one
10-
check-run (typically an Azure Pipeline). When all check-runs associated
11-
with this pull request pass then Check Enforcer itself will pass.
12-
13-
# Why am I getting this message?
14-
15-
You are getting this message because Check Enforcer did not detect any
16-
check-runs being associated with this pull request within five minutes. This
17-
may indicate that your pull request is not covered by any pipelines and so
18-
Check Enforcer is correctly blocking the pull request being merged.
19-
20-
# What should I do now?
21-
22-
If the **check-enforcer** check-run is not passing and all other check-runs
23-
associated with this PR are passing (excluding _license-cla_) then you could
24-
try telling _Check Enforcer_ to evaluate your pull request again. You can
25-
do this by adding a comment to this pull request as follows:
26-
27-
```
28-
/check-enforcer evaluate
29-
```
30-
31-
Typically evaulation only takes a few seconds. If you know that your pull
32-
request is not covered by a pipeline and this is expected you can override
33-
Check Enforcer using the following command:
34-
35-
```
36-
/check-enforcer override
37-
```
38-
39-
Note that using the override command triggers alerts so that follow-up
40-
investigations can occur (PRs still need to be approved as normal).
41-
42-
# What if I am onboarding a new service?
43-
44-
Often, new services do not have validation pipelines associated with them.
45-
In order to bootstrap pipelines for a new service, please perform following steps:
46-
47-
## For data-plane/track 2 SDKs
48-
Issue the following command as a pull request comment:
49-
50-
```
51-
/azp run prepare-pipelines
52-
```
53-
54-
This will run a pipeline that analyzes the source tree and creates the
55-
pipelines necessary to build and validate your pull request. Once the pipeline
56-
has been created you can trigger the pipeline using the following comment:
57-
58-
```
59-
/azp run net - [service] - ci
60-
```
61-
62-
## For track 1 management-plane SDKs
63-
64-
Please open a separate PR and to your service SDK path in [this file](https://github.com/Azure/azure-sdk-for-net/blob/main/eng/pipelines/mgmt.yml). Once that PR has been merged, you can re-run the pipeline to trigger the verification.
65-
7+
For more information about how to run a pipeline against this pull request, see [this](https://github.com/Azure/azure-sdk-for-net/blob/main/eng/checkenforcer.md).

eng/checkenforcer.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# What is Check Enforcer?
2+
3+
Check Enforcer helps ensure all pull requests are covered by at least one
4+
check-run (typically an Azure Pipeline). When all check-runs associated
5+
with this pull request pass then Check Enforcer itself will pass.
6+
7+
# Why am I getting this message?
8+
9+
You are getting this message because Check Enforcer did not detect any
10+
check-runs being associated with this pull request within five minutes. This
11+
may indicate that your pull request is not covered by any pipelines and so
12+
Check Enforcer is correctly blocking the pull request being merged.
13+
14+
# What should I do now?
15+
16+
If the **check-enforcer** check-run is not passing and all other check-runs
17+
associated with this PR are passing (excluding _license-cla_) then you could
18+
try telling _Check Enforcer_ to evaluate your pull request again. You can
19+
do this by adding a comment to this pull request as follows:
20+
21+
```
22+
/check-enforcer evaluate
23+
```
24+
25+
Typically evaulation only takes a few seconds. If you know that your pull
26+
request is not covered by a pipeline and this is expected you can override
27+
Check Enforcer using the following command:
28+
29+
```
30+
/check-enforcer override
31+
```
32+
33+
Note that using the override command triggers alerts so that follow-up
34+
investigations can occur (PRs still need to be approved as normal).
35+
36+
# What if I am onboarding a new service?
37+
38+
Often, new services do not have validation pipelines associated with them.
39+
In order to bootstrap pipelines for a new service, please perform following steps:
40+
41+
## For data-plane/track 2 SDKs
42+
Issue the following command as a pull request comment:
43+
44+
```
45+
/azp run prepare-pipelines
46+
```
47+
48+
This will run a pipeline that analyzes the source tree and creates the
49+
pipelines necessary to build and validate your pull request. Once the pipeline
50+
has been created you can trigger the pipeline using the following comment:
51+
52+
```
53+
/azp run net - [service] - ci
54+
```
55+
56+
## For track 1 management-plane SDKs
57+
58+
Please open a separate PR and to your service SDK path in [this file](https://github.com/Azure/azure-sdk-for-net/blob/main/eng/pipelines/mgmt.yml). Once that PR has been merged, you can re-run the pipeline to trigger the verification.

0 commit comments

Comments
 (0)