Skip to content

Commit 0a6b258

Browse files
committed
docs: pretty README.md
1 parent 15d04cd commit 0a6b258

File tree

2 files changed

+13
-9
lines changed

2 files changed

+13
-9
lines changed

README.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,11 @@
33
> [!NOTE]
44
> SCM Engine allow for easy Merge Request automation within your GitLab projects.
55
>
6-
> Automatically add / remove labels depending on files changes, age of the Merge Request, who contributes,
7-
> and pretty much anything else you could want.
6+
> Automatically [add/remove labels](https://jippi.github.io/scm-engine/configuration/#label) depending on files changes, the age of the Merge Request, who contributes, and pretty much anything else you could want.
87
>
9-
> SCM engine can be run either as a regular CI job in your pipeline, or be triggered through the Webhook system, allowing for versatile and flexible deployments.
8+
> You can even [*take actions*](https://jippi.github.io/scm-engine/configuration/#actions) such as ([but not limited to](https://jippi.github.io/scm-engine/configuration/#actions.if.then.action)) closing the Merge Request, approve it, or add a comment.
9+
>
10+
> SCM engine can be run either as a [regular CI job in your pipeline](https://jippi.github.io/scm-engine/gitlab/setup/#gitlab-ci-pipeline), or be [triggered through the Webhook system](https://jippi.github.io/scm-engine/gitlab/setup/#webhook-server), allowing for versatile and flexible deployments.
1011
1112
## Example
1213

docs/index.md

+9-6
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
# About
22

3-
> SCM Engine allow for easy Merge Request automation within your GitLab projects.
4-
>
5-
> Automatically add / remove labels depending on files changes, age of the Merge Request, who contributes,
6-
> and pretty much anything else you could want, thanks to the usage of [expr-lang](https://expr-lang.org/).
7-
>
8-
> SCM engine can be run either as a regular CI job in your pipeline, or be triggered through the Webhook system, allowing for versatile and flexible deployments.
3+
!!! info "About `scm-engine`"
4+
5+
SCM Engine allow for easy Merge Request automation within your GitLab projects.
6+
7+
Automatically [add/remove labels](configuration/index.md#label) depending on files changes, the age of the Merge Request, who contributes, and pretty much anything else you could want.
8+
9+
You can even [*take actions*](configuration/index.md#actions) such as ([but not limited to](configuration/index.md#actions.if.then.action)) closing the Merge Request, approve it, or add a comment.
10+
11+
SCM engine can be run either as a [regular CI job in your pipeline](gitlab/setup.md#gitlab-ci-pipeline), or be [triggered through the Webhook system](gitlab/setup.md#webhook-server), allowing for versatile and flexible deployments.

0 commit comments

Comments
 (0)