Skip to content

Commit 44058fd

Browse files
committed
feat: add support matrix shortcode
Added a support matrix shortcode to the policy guide to indicate which Git providers support specific features. This includes GitHub App, GitHub Webhook, Gitea, GitLab, Bitbucket Cloud, and Bitbucket Server. Update pull_request default template so that the dev can communicate it in the pull_request. Signed-off-by: Chmouel Boudjnah <[email protected]>
1 parent 7db78c0 commit 44058fd

File tree

3 files changed

+62
-0
lines changed

3 files changed

+62
-0
lines changed

.github/pull_request_template.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,14 @@ your descriptive commit message(s)! -->
1818
- [ ] 🎁 If feasible, please check if an end-to-end test can be added. See [README](https://github.com/openshift-pipelines/pipelines-as-code/blob/main/test/README.md) for more details.
1919

2020
- [ ] 🔎 If there's any flakiness in the CI tests, don't necessarily ignore it. It's better to address the issue before merging, or provide a valid reason to bypass it if fixing isn't possible (e.g., token rate limitations).
21+
22+
- If you are adding a provider feature, please fill up the following details which provider this feature supports:
23+
24+
- [ ] GitHub
25+
- [ ] GitHub Webhook
26+
- [ ] Gitea
27+
- [ ] Gitlab
28+
- [ ] Bitbucket Cloud
29+
- [ ] Bitbucket Server/DC
30+
31+
(make sure to update the documentation accordingly)

docs/content/docs/guide/policy.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ Pipelines-as-Code uses policies to control which actions can be performed by
99
users who belong to specific teams within an organization, as defined on GitHub
1010
or other supported Git providers (currently GitHub and Gitea).
1111

12+
{{< support_matrix github_app="true" github_webhook="true" gitea="true" gitlab="false" bitbucket_cloud="false" bitbucket_server="false" >}}
13+
1214
## Supported Actions
1315

1416
* `pull_request` - This action triggers the CI in Pipelines-as-Code. Specifying
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
{{ $gitlabSupported := .Get "gitlab" }} {{ $githubAppSupported := .Get
2+
"github_app" }} {{ $githubWebhookSupported := .Get "github_webhook" }} {{
3+
$giteaSupported := .Get "gitea" }} {{ $gitlabSupported := .Get "gitlab" }} {{
4+
$bitbucketCloudSupported := .Get "bitbucket_cloud" }} {{
5+
$bitbucketServerSupported := .Get "bitbucket_server" }}
6+
7+
<blockquote class="book-hint warning">
8+
<p>This feature is supported on the following providers</p>
9+
<table>
10+
<thead>
11+
<tr>
12+
<th>Git Provider</th>
13+
<th>Supported</th>
14+
</tr>
15+
</thead>
16+
<tbody>
17+
<tr>
18+
<td>GitHub App</td>
19+
<td>{{ if eq $githubAppSupported "true" }}✅️{{ else }}❌️{{ end }}</td>
20+
</tr>
21+
<tr>
22+
<td>GitHub Webhook</td>
23+
<td>
24+
{{ if eq $githubWebhookSupported "true" }}✅️{{ else }}❌️{{ end }}
25+
</td>
26+
</tr>
27+
<tr>
28+
<td>Gitea</td>
29+
<td>{{ if eq $giteaSupported "true" }}✅️{{ else }}❌️{{ end }}</td>
30+
</tr>
31+
<tr>
32+
<td>GitLab</td>
33+
<td>{{ if eq $gitlabSupported "true" }}✅️{{ else }}❌️{{ end }}</td>
34+
</tr>
35+
<tr>
36+
<td>Bitbucket Cloud</td>
37+
<td>
38+
{{ if eq $bitbucketCloudSupported "true" }}✅️{{ else }}❌️{{ end }}
39+
</td>
40+
</tr>
41+
<tr>
42+
<td>Bitbucket Server</td>
43+
<td>
44+
{{ if eq $bitbucketServerSupported "true" }}✅️{{ else }}❌️{{ end }}
45+
</td>
46+
</tr>
47+
</tbody>
48+
</table>
49+
</blockquote>

0 commit comments

Comments
 (0)