Skip to content

Commit

Permalink
Update the text content in many places. Changed reporter field UI. (j…
Browse files Browse the repository at this point in the history
  • Loading branch information
ayushk048-Ajmera authored Jun 30, 2022
1 parent 93594a4 commit fe24abe
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 22 deletions.
14 changes: 6 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Redpen - Pipeline Reporter for Jira

## Introduction

Redpen Jenkins plugin is an open-sourced plugin that is used to integrate Jenkins with [Jira Software](https://www.atlassian.com/software/jira). This plugin is free to use and provides an easy, secure, and reliable way to send build and deployment information from your Jenkins server to your Jira Software. The pipeline reports the build and deployment status (failure or success) with other meaningful data into the Jira issues which helps your team to track and collaborate on the work.
Redpen Jenkins plugin is an open-sourced plugin that is used to integrate Jenkins with [Jira Software](https://www.atlassian.com/software/jira). The Redpen Jenkins plugin provides an easy and secure way to send the information of failure build from Jenkins server to your Jira sites. The pipeline reports the failure status of the build and deployment with meaningful data directly into the Jira issues which helps your team to track and collaborate on the work.

## Benefits
- This plugin integration gives visibility to your team of the CI/CD pipelines related to Jira issues.
Expand All @@ -11,16 +10,15 @@ Redpen Jenkins plugin is an open-sourced plugin that is used to integrate Jenkin

- The plugin eliminates the manual work required by **Software Engineers** to update the Jira issues with the pipeline details.

- The plugin provides visibility to **Product Managers, Team Leads,** and **QA Engineers** into the pipeline like failing or passing builds, tests, and deployments.
- The plugin provides visibility to **Product Managers**, **Team Leads**, and **QA Engineers** into the pipeline like failing builds, tests, and deployments.

## How to get started
There are four steps to get started with the integration:

1. Install Redpen Jenkins Plugin

2. Generate a new Jenkins Credentials
3. Generate Jira API token of an Atlassian user account
4. Configure Redpen Jenkins Plugin into a Jenkins Job
1. Install Redpen for Jenkins add-on from Jira Marketplace.
2. Generate a new Jenkins Credentials from Jira.
3. Install Redpen Jenkins Plugin from Plugin manager.
4. Configure Redpen Jenkins Plugin into a Jenkins job.

[Click here](https://support.redpen.ai/hc/en-us/articles/4727856045069) and follow the steps to integrate and configure the plugin.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,14 @@
<f:entry title="Redpen credentials" field="credentialId">
<c:select/>
<f:description>
Select existing or add new credentials. To add a new credentials, <a target="_blank"
href="https://app.redpen.ai/auth/signin?utm_source=jenkins_plugin&amp;utm_medium=application&amp;utm_campaign=integration"
rel="noopener noreferrer">
Sign in
</a> to Redpen and <a
href="https://support.redpen.ai/hc/en-us/articles/4613856461581-How-to-generate-new-Jenkins-Credentials-for-Redpen-Jenkins-Plugin?utm_source=jenkins_plugin&amp;utm_medium=application&amp;utm_campaign=integration"
target="_blank"
rel="noopener noreferrer">generate a Jenkins credentials
</a> for a Jira site connected.
Select existing or add new credentials. You can create new credentials from Redpen for Jenkins add-on installed in your Jira site.
</f:description>
</f:entry>
<f:advanced title="Reporter" align="right" >
<f:description>
Fill the Reporter Email and Reporter API Token to see your service user as reporter in the Jira ticket comments. This is required only if you are not using Redpen - Jira Pipeline Reporter add-on.
</f:description>

<f:entry title="Reporter" field="userEmail"
description="Add the email of the Jira user that you want to be a reporter of the comments in the Jira tickets. The email address must be a valid Jira user and has access to the Jira site. ">
<f:textbox placeholder="Email Address"/>
Expand All @@ -42,6 +39,9 @@
</f:description>
</f:entry>

</f:advanced>


<f:entry title="Unit test framework" field="unitTestFrameWork">
<f:select/>
</f:entry>
Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@
redpen.plugin=Redpen
redpen.plugin=Redpen - Pipeline Reporter for Jira
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
<div>
<p>
The Redpen Jenkins plugin provides an easy, and secure way to connect and send build and deployment
information from your Jenkins server to your Jira sites. The pipeline reports the build and deployment status
(failure or success) with other meaningful data directly into the Jira issues which helps your team to track and
collaborate.
The Redpen Jenkins plugin provides an easy and secure way to send the information of failure build from Jenkins
server to your Jira sites. The pipeline reports the failure status of the build and deployment with meaningful
data directly into the Jira issues which helps your team to track and collaborate.
</p>
<p>
This plugin gives visibility to your team of the CI/CD pipelines related to Jira issues. The plugin adds the
Expand Down

0 comments on commit fe24abe

Please sign in to comment.