deblan/woodpecker-email
deblan/woodpecker-email
1
0
Fork 0
Code Issues 1 Pull requests Packages Projects Releases Wiki Activity

prettify documentation

Browse source
This commit is contained in:
Simon Vieille 2024-02-21 19:08:10 +01:00
parent e1700c42b0
commit f53ebebeb2
Signed by: deblan
GPG key ID: 579388D585F70417
1 changed files with 2 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
DOCS.md
View file

@ -12,7 +12,7 @@ url: https://gitnet.fr/deblan/woodpecker-email
## Settings ## Settings
| Settings Name | Required | Type | Description | Documentation | | Settings Name | Required | Type | Description | Documentation |
| --- | --- | --- | --- | --- | | --------------- | -------- | ------------------ | ------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| dsn | yes | `string` | Mail transport configuration | [Documentation](https://symfony.com/doc/current/mailer.html#tls-peer-verification) | | dsn | yes | `string` | Mail transport configuration | [Documentation](https://symfony.com/doc/current/mailer.html#tls-peer-verification) |
| from.address | yes | `string` | Email address of the sender | | | from.address | yes | `string` | Email address of the sender | |
| from.name | no | `string` | Name of the sender | | | from.name | no | `string` | Name of the sender | |
@ -23,11 +23,8 @@ url: https://gitnet.fr/deblan/woodpecker-email
| attachments | no | `string` or `list` | List of files to attach | YAML list or comma separated list | | attachments | no | `string` or `list` | List of files to attach | YAML list or comma separated list |
| debug | no | `boolean` | Debug mode (email are sent!) | | | debug | no | `boolean` | Debug mode (email are sent!) | |
### Example ### Example
``` ```
steps: steps:
mail: mail:
@ -52,14 +49,12 @@ steps:
- log/* - log/*
``` ```
### Evaluation and content ### Evaluation and content
See the [Twig documentation](https://twig.symfony.com/doc/3.x/). See the [Twig documentation](https://twig.symfony.com/doc/3.x/).
| Variable | Value | | Variable | Value |
| --- | --- | | ----------------------------- | -------------------------------- |
| `workspace` | `CI_WORKSPACE` | | `workspace` | `CI_WORKSPACE` |
| `repo.full_name` | `CI_REPO` | | `repo.full_name` | `CI_REPO` |
| `repo.owner` | `CI_REPO_OWNER` | | `repo.owner` | `CI_REPO_OWNER` |