From b7983a817e4db67f708f5f750a01cbbdd8c1f363 Mon Sep 17 00:00:00 2001 From: Andreas Schaeffer Date: Mon, 23 Jan 2023 00:14:46 +0100 Subject: [PATCH] Documented component git and added plugin description --- plugins/git/README.md | 26 +++++++++++++++++--------- 1 file changed, 17 insertions(+), 9 deletions(-) diff --git a/plugins/git/README.md b/plugins/git/README.md index 1da244df..4665d468 100644 --- a/plugins/git/README.md +++ b/plugins/git/README.md @@ -1,17 +1,25 @@ # Plugin Git +This plugin provides git functionality. You can clone a repository, fetch, pull and fast-forward. + ## Component -| Property | Component | DataType | SocketType | Description | -|---------------|---------------------|----------|------------|-----------------------------------------------------------| -| `name` | `base__named` | `String` | `none` | The name. | -| `description` | `base__describable` | `String` | `none` | The description. | -| `url` | `http__url` | `String` | `none` | The remote url. | -| `file` | `file_file` | `String` | `none` | The local path. | -| `branch` | `git__git` | `String` | `none` | The git branch name. Executes a `git checkout` on change. | +| Property | Component | DataType | SocketType | Description | +|-----------------|---------------------|-----------|------------|-----------------------------------------------------------| +| `name` | `base__named` | `String` | `none` | The name. | +| `description` | `base__describable` | `String` | `none` | The description. | +| `url` | `http__url` | `String` | `input` | The remote url. | +| `file` | `file_file` | `String` | `input` | The local path. | +| `branch` | `git__git` | `String` | `input` | The git branch name. Executes a `git checkout` on change. | +|| +| `remote_name` | `git__git` | `String` | `input` | The name of the remote (default: `origin`). | +| `remote_branch` | `git__git` | `String` | `input` | The name of the remote branch | || -| `merge_from` | `git__git` | `String` | `input` | Merges the given branch into the current branch | -| `push` | `git__git` | `String` | `input` | Pushes to the given remote (by default origin) | +| `trigger` | `git__git` | `Bool` | `input` | Clone or pull | +| `fetch` | `git__git` | `Bool` | `input` | Fetch | +| `fast_forward` | `git__git` | `Bool` | `input` | Fast-forward | +| `push` | `git__git` | `Bool` | `input` | Pushes to the given remote (by default origin) | +| `merge_from` | `git__git` | `String` | `input` | Merges the given branch into the current branch | ## Platform Compatibility