Skip to content

Commit e35d238

Browse files
bhavyalatha26bhavyalatha26
authored
Merge pull request #3 from jenkinsci/add-labels-and-maintainers
Add maintainers list and few updates to README
2 parents 29d9d11 + ebcc153 commit e35d238

File tree

2 files changed

+97
-33
lines changed

2 files changed

+97
-33
lines changed

‎README.md‎

Lines changed: 69 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -2,66 +2,84 @@
22

33
Provides integration to send build level notifications to [CloudAEye](https://www.cloudaeye.com/) to perform RCA(Root Cause Analysis) over test failures.
44

5-
## Install Instructions for CloudAEye Plugin
5+
## Install the Plugin
66

7-
1. Install this plugin on your Jenkins server:
7+
To install this plugin on your Jenkins server, follow the below steps:
88

9-
1. From the Jenkins homepage navigate to `Manage Jenkins`
10-
2. Navigate to `Manage Plugins`,
11-
3. Change the tab to `Available`,
12-
4. Search for `CloudAEye`,
13-
5. Check the box next to install.
9+
1. On Jenkins dashboard click on `Manage Jenkins` on left menu.
10+
2. Under **System Configuration** select `Plugins`.
11+
3. Click on `Available Plugins` option in left menu.
12+
4. Search for `CloudAEye` and click the `Install` button next to the search box.
1413

15-
### Configuring the Plugin
14+
## Configure the Plugin
1615

17-
*On CloudAEye :*
18-
1. Create an account: CloudAEye offers a **free tier** for individual developers. You may get started by signing up [here](https://console.cloudaeye.com/signup). You can read more about the free-tier [here](https://docs.cloudaeye.com/free-tier.html)
19-
2. Navigate to Home > Test RCA > Setup.
20-
3. Select `Jenkins` from the list of available integrations.
16+
### Step 1: Fetch plugin credentials from CloudAEye :
17+
18+
1. Login to your CloudAEye account (If you do not already have an account, you can create one by signing up [here](https://console.cloudaeye.com/signup)
19+
> CloudAEye offers a **free tier** for individual developers. You can read more about the free-tier [here](https://docs.cloudaeye.com/free-tier.html)
20+
2. Navigate to `Home > Test RCA > Setup`.
21+
3. Select `Connect Jenkins` from the list of available integrations.
2122
4. Copy the `Tenant ID` and `Token` values from the step-by-step guide.
2223

2324
![image][img-cloudaeye-setup]
2425
![image][img-cloudaeye-creds]
2526

26-
*On Jenkins :*
27-
1. Goto "Manage Jenkins → System". Search for the CloudAEye configuration section
28-
2. Fill in the `Tenant ID` and `Token` values copied from above steps.
29-
3. Click `Test Connection`. This would make a ping to the CloudAEye's webhook endpoint to test the connection.
27+
### Step 2: Configure the plugin globally in Jenkins
28+
29+
1. On Jenkins dashboard click on `Manage Jenkins` on left menu.
30+
2. Under **System Configuration** select `System`.
31+
3. Search for the `CloudAEye Configuration` section
32+
4. Fill in the `Tenant ID` and `Token` values copied from above steps.
33+
5. Click `Test Connection`.
34+
> This would ping the CloudAEye's webhook endpoint to test the connection. A success message indicates the plugin is configured successfully.
3035
3136
![image][img-global-configuration]
3237

3338

34-
### Enable plugin for Free-style jobs
39+
## Enable Plugin for Jenkins Jobs
40+
41+
### For Free-style Jobs:
3542

36-
1. From Dashboard, select the required free-style project.
37-
2. Goto Configure > Post Build Actions. Search for the name `Send build notifications to CloudAEye`.
38-
3. Click check box to `Enable sending build notifications to CloudAEye`
39-
4. Save your changes
43+
1. On Dashboard, select the required free-style project.
44+
2. On the left menu select **Configure > Post Build Actions**.
45+
3. Search for the name `Send build notifications to CloudAEye`.
46+
4. Click check box to `Enable sending build notifications to CloudAEye`
47+
5. Save your changes
4048

4149
![image][img-add-as-postbuild]
4250
![image][img-enable-postbuild]
4351

44-
### Enable plugin for pipeline jobs
52+
### For Pipeline Jobs:
4553

46-
1. From Dashboard, select the required pipeline project.
47-
2. Goto Pipeline Syntax > Snippet Generator
48-
3. In Sample Step drop down, select the option `sendNotificationsToCloudAEye: Send build notifications to CloudAEye`
49-
4. Check the option to enable sending build notifications
50-
5. Click `Generate Pipeline Script`.
51-
6. Open the `Jenkinsfile` script file in the select project repo.
52-
7. Copy the snippet generated in step 5 and add it in the post section of the script
54+
1. On Dashboard, select the required pipeline project.
55+
2. On left menu select **Pipeline Syntax > Snippet Generator**
56+
3. In the **Sample Step** drop down, select the option `sendNotificationsToCloudAEye: Send build notifications to CloudAEye`
57+
4. Click check box to `Enable sending build notifications to CloudAEye`
58+
5. Click on `Generate Pipeline Script`.
59+
6. Open the `Jenkinsfile` script file in the corresponding github project repo and copy the snippet generated in step 5 and add it in the `post section` of the script
5360
```
5461
post {
5562
always {
5663
sendNotificationsToCloudAEye true
5764
}
5865
}
5966
```
67+
7. Commit and deploy the changes
68+
6069
![image][img-pipeline-script-generator]
6170

71+
---
72+
6273
## Developer instructions
6374

64-
Install Maven and JDK.
75+
### Setting Up:
76+
77+
- Clone this repository on to your local machine
78+
```shell
79+
git clone https://github.com/jenkinsci/cloudaeye-plugin
80+
```
81+
82+
- Install Maven and JDK.
6583

6684
```shell
6785
$ mvn -version | grep -v home
@@ -71,12 +89,31 @@ Default locale: en_US, platform encoding: UTF-8
7189
OS name: "linux", version: "4.4.0-65-generic", arch: "amd64", family: "unix"
7290
```
7391

74-
Create an HPI file to install in Jenkins (HPI file will be in
75-
`target/cloudaeye.hpi`).
92+
### Deployment:
7693

94+
After making changes to the plugin repo, follow the below steps to successfully deploy the changes to Jenkins
95+
96+
- Always work on a feature branch (DO NOT work and push changes directly from main branch).
97+
98+
- Run the below command to locally build and test your plugin.
7799
```shell
78100
mvn clean package
79101
```
102+
> This creates a HPI file that can be installed on your Jenkins server (HPI file will be in `target/cloudaeye.hpi`
103+
104+
- Fix lint issues (if any)
105+
106+
```shell
107+
mvn spotless:apply
108+
```
109+
110+
> This is important because Jenkins build fails if there are any lint issues
111+
112+
- Push the changes and create a PR to the `main` branch.
113+
114+
NOTE: Make sure to apply [appropriate labels](https://github.com/jenkinsci/.github/blob/master/.github/release-drafter.yml) to the PR that falls into the [interesting category actions](https://github.com/jenkins-infra/interesting-category-action/blob/main/action.yaml#L13) to automatically trigger a release
115+
116+
- Once all `github checks pass`, merge the PR to deploy the changes to Jenkins
80117

81118
[img-global-configuration]: /docs/GlobalConfiguration.png
82119
[img-cloudaeye-setup]: /docs/CloudAEyeSetup.png

‎pom.xml‎

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,32 @@
2222
<url>https://opensource.org/license/mit/</url>
2323
</license>
2424
</licenses>
25+
<developers>
26+
<developer>
27+
<id>bhavyalatha26</id>
28+
<name>Bhavya Latha Bandaru</name>
29+
<url>https://github.com/bhavyalatha26</url>
30+
<roles>
31+
<role>maintainer</role>
32+
</roles>
33+
</developer>
34+
<developer>
35+
<id>PiyushKumar11</id>
36+
<name>Piyush Kumar</name>
37+
<url>https://github.com/PiyushKumar11</url>
38+
<roles>
39+
<role>maintainer</role>
40+
</roles>
41+
</developer>
42+
<developer>
43+
<id>nazrul-cloudaeye</id>
44+
<name>Nazrul Islam</name>
45+
<url>https://github.com/nazrul-cloudaeye</url>
46+
<roles>
47+
<role>maintainer</role>
48+
</roles>
49+
</developer>
50+
</developers>
2551
<scm child.scm.connection.inherit.append.path="false" child.scm.developerConnection.inherit.append.path="false" child.scm.url.inherit.append.path="false">
2652
<connection>scm:git:https://github.com/${gitHubRepo}</connection>
2753
<developerConnection>scm:git:https://github.com/${gitHubRepo}</developerConnection>
@@ -34,7 +60,8 @@
3460
<!-- https://www.jenkins.io/doc/developer/plugin-development/choosing-jenkins-baseline/ -->
3561
<jenkins.version>2.440.3</jenkins.version>
3662
<gitHubRepo>jenkinsci/${project.artifactId}-plugin</gitHubRepo>
37-
63+
<!-- https://github.com/jenkins-infra/update-center2/blob/master/resources/allowed-github-topics.properties-->
64+
<jenkins.plugin.labels>label1,label2,label3</jenkins.plugin.labels>
3865
<spotless.check.skip>false</spotless.check.skip>
3966
</properties>
4067

0 commit comments

Comments
 (0)