Radish alpha
r
rad:zwTxygwuz5LDGBq255RA2CbNGrz8
Radicle CI broker
Radicle
Git
doc(doc/userguide.md): document new tag events and filters
Lars Wirzenius committed 1 year ago
commit 6ec75d19784849cadf50201a0e1de0338eb277e6
parent a7d02c1
1 file changed +37 -0
modified doc/userguide.md
@@ -261,6 +261,40 @@ A branch has been deleted.
|                 | `branch`    | `BranchName`|
|                 | `tip`       | `Oid`       |

+
## `TagCreated`
+

+
An annotated Git tag has been created.
+

+
| Event           | fields              | field types |
+
|:----------------|:--------------------|:------------|
+
| `TagCreated`    | `from_node`         | `NodeId`    |
+
|                 | `repo`              | `RepoId`    |
+
|                 | `tag_name`          | `RefString` |
+
|                 | `tip`               | `Oid`       |
+

+
## `TagUpdated`
+

+
An annotated Git tag has been updated.
+

+
| Event           | fields      | field types |
+
|:----------------|:------------|:------------|
+
| `TagUpdated`    | `from_node` | `NodeId`    |
+
|                 | `repo`      | `RepoId`    |
+
|                 | `tag_name`  | `RefString` |
+
|                 | `tip`       | `Oid`       |
+
|                 | `old_tip`   | `Oid`       |
+

+
## `TagDeleted`
+

+
An annotated Git tag has been deleted.
+

+
| Event           | fields      | field types |
+
|:----------------|:------------|:------------|
+
| `TagDeleted`    | `from_node` | `NodeId`    |
+
|                 | `repo`      | `RepoId`    |
+
|                 | `tag_name`  | `RefString` |
+
|                 | `tip`       | `Oid`       |
+

## `PatchCreated`

A patch has been created.
@@ -298,6 +332,9 @@ Otherwise it is discarded and does not trigger a CI run.
| `BranchCreated`   | Branch was created                                        |
| `BranchDeleted`   | Branch was deleted                                        |
| `BranchUpdated`   | Branch was updated                                        |
+
| `TagCreated`      | Annotated tag was created                                 |
+
| `TagDeleted`      | Annotated tag was deleted                                 |
+
| `TagUpdated`      | Annotated tag was updated                                 |
| `Branch`          | Event refers to a specific Git branch                     |
| `DefaultBranch`   | Event refers to a default branch of the repository        |
| `Deny`            | Changes is not allowed                                    |