|
1 | 1 | # Contribution
|
| 2 | +Thank you for your interest in making [Deploy Dashboard Plugin](https://github.com/jenkinsci/deploy-dashboard-plugin) even better and more awesome. Your contributions are highly welcome. |
| 3 | + |
| 4 | +Plugin source code is hosted on [GitHub](https://github.com/jenkinsci/deploy-dashboard-plugin). New feature proposals and bug fix proposals should be submitted as [GitHub pull requests](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request). Your pull request will be evaluated by the [Jenkins job](https://jenkins.devops.namecheap.net/job/RND/job/jenkins-deploy-dashboard-plugin/). |
2 | 5 |
|
3 |
| -* [Beginners Guide to Contributing](https://wiki.jenkins.io/display/JENKINS/Beginners+Guide+to+Contributing) |
4 |
| -* [Jenkins Plugin Development Guild](https://wiki.jenkins.io/display/JENKINS/Plugin+tutorial#Plugintutorial-DistributingaPlugin) |
5 |
| -* [Original Repository](https://github.com/vipinsthename/environment-dashboard) |
6 |
| -* [Based on Pull Request](https://github.com/vipinsthename/environment-dashboard/pull/135) |
7 | 6 |
|
8 | 7 | ## Development
|
9 | 8 |
|
10 |
| -### Requirements |
| 9 | +There is an official [Jenkins Plugin Development Guild](https://wiki.jenkins.io/display/JENKINS/Plugin+tutorial) by Jenkins. All the details you will find there. |
11 | 10 |
|
12 |
| -* JDK 8.0 or later |
| 11 | +In short, you have to be familiar with java (jdk 1.8 is required) and maven build tool. |
13 | 12 |
|
14 |
| -### Development |
| 13 | +```bash |
| 14 | +./mvnw clean install |
| 15 | +``` |
| 16 | +This command will build the plugin. The `hpi` file you can find in the `target` folder. |
15 | 17 |
|
16 |
| -[Debugging a Plugin](https://wiki.jenkins.io/display/JENKINS/Plugin+tutorial#Plugintutorial-DebuggingaPlugin) |
| 18 | +## Release (Only for Plugin's maintainers) |
17 | 19 |
|
18 |
| -`NOTE: findbugs is skipped, plugin has some code analysis issues. See pom.xml` |
| 20 | +Official documentation: [Performing a Plugin Release](https://jenkins.io/doc/developer/publishing/releasing/) |
19 | 21 |
|
20 |
| -```bash |
21 |
| -export MAVEN_OPTS="-Xdebug -Xrunjdwp:transport=dt_socket,server=y,address=8000,suspend=n" |
22 |
| -$ ./mvnw hpi:run |
23 |
| -``` |
| 22 | +There is `Jenkinsfile.release` file in the root directory which you can use as jenkins pipeline |
24 | 23 |
|
25 |
| -### Build |
| 24 | +**For Namecheap employees only:** There is Jenkins job `https://{{NC_JENKINS_DOMAIN}}/job/RND/job/jenkins-deploy-dashboard-plugin/`. |
| 25 | +By running this job the new version (taken from [pom.xml](pom.xml) file) will be published. |
26 | 26 |
|
27 |
| -```bash |
28 |
| -$ ./mvnw package |
29 |
| -# This should create target/*.hpi file. Other users can use Jenkins' web UI to upload this plugin to Jenkins (or place it in $JENKINS_HOME/plugins.) |
30 |
| -``` |
| 27 | +P.S. It usually takes time when the new version appears in the jenkins registry search. |
0 commit comments