Add description of configuration

Aeliot-Tm · Jun 13, 2024 · d9002df · d9002df
1 parent fd2ad42
commit d9002df
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -107,6 +107,6 @@ System pass it in payload to registrar with aim to be used as "identifier" of as
 
 Currently, todo-registrar supports the following issue trackers:
 
-| Issue Tracker                                   | Description              |
-|-------------------------------------------------|--------------------------|
-| [Jira](https://www.atlassian.com/software/jira) | Supported via API tokens |
+| Issue Tracker                                   | Description                                                                                 |
+|-------------------------------------------------|---------------------------------------------------------------------------------------------|
+| [Jira](https://www.atlassian.com/software/jira) | Supported via API tokens. See [description of configuration](docs/registrar/jira/config.md) |
diff --git a/docs/registrar/jira/config.md b/docs/registrar/jira/config.md
@@ -0,0 +1,28 @@
+# Configuration of JIRA-registrar
+
+Description of keys:
+```php
+$jiraConfig = [
+    'issue' => [
+        'addTagToLabels' => true,                   // add detected tag into list of issue labels or not
+        'assignee' => 'string'                      // identifier of JIRA-user, which will be assigned to ticket
+                                                    // when "assignee-suffix" was not used with tag.
+        'components' => ['a-component'],            // list of components which will be set to issue 
+        'labels' => ['a-label'],                    // list of labels which will be set to issue
+        'tagPrefix' => 'tag-',                      // prefix which will be added to tag when "addTagToLabels=true"
+        'type' => 'Bug',                            // type of issue
+    ],
+    'projectKey' => 'string',                       // key-name of project
+    'service' => [
+        'host' => 'string',                         // host of JIRA-server
+        'personalAccessToken' => 'string',          // personal access-token
+        'tokenBasedAuth' => true,
+
+        // JIRA username and password can be used as alternative for authentication on JIRA-server.
+        // So, previous option "tokenBasedAuth" must be set to "false".
+        //
+        // 'jiraUser' => 'string',
+        // 'jiraPassword' => 'string',
+    ]
+];
+```