Skip to content

Commit e69ff16

Browse files
committed
docs: rework things a bit more
1 parent 99e24b6 commit e69ff16

File tree

7 files changed

+30
-9
lines changed

7 files changed

+30
-9
lines changed

Dockerfile.docs

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
FROM squidfunk/mkdocs-material
22

3+
# https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin
34
RUN pip install mkdocs-awesome-pages-plugin
45
RUN pip install mkdocs-git-revision-date-localized-plugin
56
RUN pip install mkdocs-git-authors-plugin

docs/commands/evaluate.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
hide:
3+
- toc
4+
---
5+
16
# Evaluate
27

38
Evaluate the SCM engine rules against a specific Merge Request.

docs/commands/sever.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
hide:
3+
- toc
4+
---
5+
16
# Server
27

38
Point your GitLab webhook at the `/gitlab` endpoint.

docs/gitlab/.pages

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
arrange:
2+
- setup.md
3+
- ...

docs/gitlab/script-attributes.md

+14-5
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11
# Script Attributes
22

3-
!!! TIP "The [Expr Language Definition](https://expr-lang.org/docs/language-definition) is a great resource to learn more about the language"
4-
5-
!!! TIP "`webhook_event`"
6-
7-
You have access to the raw webhook event payload via `webhook_event.*` attributes (not listed below) in Expr script fields when using [`server`](#server) mode. See the [GitLab Webhook Events documentation](https://docs.gitlab.com/ee/user/project/integrations/webhook_events.html) for available fields. The attributes are named _exactly_ as documented in the GitLab documentation.
3+
!!! tip "The [Expr Language Definition](https://expr-lang.org/docs/language-definition) is a great resource to learn more about the language"
84

95
!!! note
106

@@ -138,3 +134,16 @@ They can be accessed exactly as shown in this list.
138134
- `project.labels[].description` (string) Description of the label (Markdown rendered as HTML for caching)
139135
- `project.labels[].id` (string) Label ID
140136
- `project.labels[].title` (string) Content of the label
137+
138+
## `webhook_event`
139+
140+
!!! tip "`webhook_event` attribute is only available in `server` mode"
141+
142+
You have access to the raw webhook event payload via `webhook_event.*` attributes (not listed below) in Expr script fields when using [`server`](#server) mode.
143+
144+
See the [GitLab Webhook Events documentation](https://docs.gitlab.com/ee/user/project/integrations/webhook_events.html) for available fields.
145+
146+
The attributes are named _exactly_ as documented in the GitLab documentation.
147+
148+
- [`Comments`](https://docs.gitlab.com/ee/user/project/integrations/webhook_events.html#comment-events) - A comment is made or edited on an issue or merge request.
149+
- [`Merge request events`](https://docs.gitlab.com/ee/user/project/integrations/webhook_events.html#merge-request-events) - A merge request is created, updated, or merged.

docs/gitlab/script-functions.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# Script Functions
22

3-
!!! TIP
4-
5-
The [Expr Language Definition](https://expr-lang.org/docs/language-definition) is a great resource to learn more about the language. This guide will only cover SCM Engine specific extensions and information.
3+
!!! tip "The [Expr Language Definition](https://expr-lang.org/docs/language-definition) is a great resource to learn more about the language"
64

75
## merge_request
86

docs/gitlab/getting-started.md docs/gitlab/setup.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Getting Started
1+
# Setup
22

33
## Webhook Server
44

0 commit comments

Comments
 (0)