From aa52bece1f68f964d8012346c33430b0b816a4cf Mon Sep 17 00:00:00 2001 From: gitea_admin Date: Wed, 11 Mar 2026 14:37:13 +0000 Subject: [PATCH] Update wiki Home page for jira-add-issue-sink --- Home.md | 57 +++++++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 43 insertions(+), 14 deletions(-) diff --git a/Home.md b/Home.md index 93a012c..40984b6 100644 --- a/Home.md +++ b/Home.md @@ -1,21 +1,50 @@ -# Deploy the Project on CamelX Platform +# Jira Add Issue Sink -Deploy on CamelX Platform in three steps +Add a new issue to Jira. -## Step 1: Create a release -From the project space, click on **"Create a release"** +The Kamelet expects the following headers to be set: -The new version is automatically available in the list +- `projectKey` / `ce-projectKey`: as the Jira project key. -## Step 2: Deploy -Click on **"Deploy"** +- `issueTypeName` / `ce-issueTypeName`: as the name of the issue type (example: Bug, Enhancement). -- **Version:** Select the desired release -- **Environment:** Choose `Development`, `Staging`, or `Production` -- **Configuration:** Select the configuration source -- **Resources:** Set CPU and Memory +- `issueSummary` / `ce-issueSummary`: as the title or summary of the issue. -## Step 3: Expose -Enable **"Expose"** +- `issueAssignee` / `ce-issueAssignee`: as the user assigned to the issue (Optional). -Choose an **API Gateway** (Internal, Public, etc.) +- `issuePriorityName` / `ce-issuePriorityName`: as the priority name of the issue (example: Critical, Blocker, Trivial) (Optional). + +- `issueComponents` / `ce-issueComponents`: as list of string with the valid component names (Optional). + +- `issueDescription` / `ce-issueDescription`: as the issue description (Optional). + +The issue description can be set from the body of the message or the `issueDescription`/`ce-issueDescription` in the header, however the body takes precedence. + +To authenticate a username/password or personal token must be defined. We recommend to use personal token as it is a safer way to get access to Jira. + +## Metadata + +| Property | Value | +|----------|-------| +| Type | sink | +| Group | JIRA | +| Namespace | JIRA | +| Support Level | Stable | +| Provider | Apache Software Foundation | + +## Properties + +| Name | Type | Required | Default | Description | +|------|------|----------|---------|-------------| +| `jiraUrl` | string | ✓ | | The URL of your instance of Jira | +| `username` | string | | | The username to access Jira | +| `password` | string | | | The password to access Jira | +| `personal-token` | string | | | Personal Token | + +## Dependencies + +- `camel:core` +- `camel:jackson` +- `camel:jira` +- `camel:kamelet` +- `mvn:com.fasterxml.jackson.datatype:jackson-datatype-joda:2.12.5`