Skip to content

Commit

Permalink
Formatting, parameter names and preparing POM for 1.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
kinow committed May 2, 2015
1 parent 6a34311 commit f331821
Show file tree
Hide file tree
Showing 22 changed files with 1,118 additions and 1,002 deletions.
2 changes: 1 addition & 1 deletion LICENSE → LICENSE.txt
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2014 Ioannis K. Moutsatsos
Copyright (c) <2014-2015> Ioannis K. Moutsatsos, Bruno P. Kinoshita

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
1 change: 1 addition & 0 deletions NOTICE.txt
@@ -0,0 +1 @@
The original design was inspired in Dynamic Parameters Plug-in (Apache License).
36 changes: 21 additions & 15 deletions README.md
@@ -1,30 +1,36 @@
uno-choice-plugin
Active Choices Plug-in
=================

A Jenkins **UI plugin for selecting one or multiple options for a job parameter**. It provides a number of capabilities in a single plugin some, but not all, of which can be found amongst several other plugins.
A Jenkins **UI plugin for selecting one or multiple options for a job parameter**. It provides a number of capabilities
in a single plugin some, but not all, of which can be found amongst several other plugins. This project was previously
called Uno Choice Plug-in, while under the BioUno project.

As of July 2014 the plugin supports:

1. Selecting one or multiple options for a parameter
2. Combo-box, check-box and radio button UI
3. Dynamic generation of option values from a groovy command or Scriptler script
4. Cascading updates when job form parameters change
5. Displaying reference parameters (a new type of Jenkins UI parameter) which are dynamically generated, support cascading updates, and are displayed as a variety of HTML formatted elements on the job form.
5. Displaying reference parameters (a new type of Jenkins UI parameter) which are dynamically generated, support
cascading updates, and are displayed as a variety of HTML formatted elements on the job form.

This plugin is developed in support of the diverse computational requirements of life-science Jenkins applications as proposed by the [BioUno project](http://biouno.org/)
This plugin is developed in support of the diverse computational requirements of life-science Jenkins applications as
proposed by the [BioUno project](http://biouno.org/).

Many parts of the code may be adapted from existing plug-ins. We ask to keep issues
related to this plug-in in this plug-in's repository in GitHub (and
not in Jenkins JIRA), and also that any enhancements found in this project
may be contributed back to the original project (or to a new one).
Many parts of the code may be adapted from existing plug-ins. We ask to keep issues related to this plug-in in
Jenkins JIRA.

Visit the [plug-in Wiki](https://github.com/biouno/uno-choice-plugin/wiki)
for more details on each parameter type.
Visit the [plug-in Wiki](https://wiki.jenkins-ci.org/display/JENKINS/Active+Choices+Plugin) for more details on each
parameter type.

# Building

You must have phantomjs in your $PATH in order to build the project. It is used to
run JS unit tests, using QUnit, JQuery and the plug-in's own code.

`mvn clean test install`

# License

This plug-in is licensed under the MIT License. Parts of this plug-in
may have been adapter/rewritten from existing plug-ins with similar
licens (e.g.: Apache License). In case we missed anything while
porting code, or if we forgot to give credits, please let us know via
http://biouno.org. Thanks!
This plug-in is licensed under the MIT License. Parts of this plug-in have been adapted from existing plug-ins
with compatible licenses (e.g.: Apache License).
129 changes: 68 additions & 61 deletions pom.xml
@@ -1,98 +1,89 @@
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">

<modelVersion>4.0.0</modelVersion>

<parent>
<groupId>org.jenkins-ci.plugins</groupId>
<artifactId>plugin</artifactId>
<version>1.580.1</version><!-- which version of Jenkins is this plugin built
against? -->
<version>1.580.1</version><!-- which version of Jenkins is this plugin
built against? -->
</parent>

<groupId>org.biouno</groupId>
<artifactId>uno-choice</artifactId>
<version>0.25-SNAPSHOT</version>
<version>1.0-SNAPSHOT</version>
<packaging>hpi</packaging>
<name>Uno-Choice Plug-in</name>
<description>This plug-in provides additional parameter types for jobs, that allow you to cascade changes and render images or other HTML elements instead of the traditional parameter.</description>

<organization>
<name>BioUno</name>
<url>http://www.biouno.org</url>
</organization>
<name>Active Choices Plug-in</name>
<description>This plug-in provides additional parameter types for jobs, that allow you to cascade changes and render images or other HTML elements instead of the traditional parameter.</description>

<url>https://wiki.jenkins-ci.org/display/JENKINS/Active+Choices+Plugin</url>

<issueManagement>
<system>JIRA</system>
<url>https://issues.jenkins-ci.org/secure/IssueNavigator.jspa?reset=true&amp;jqlQuery=project+%3D+JENKINS+AND+status+in+%28Open%2C+"In+Progress"%2C+Reopened%29+AND+component+%3D+${project.artifactId}</url>
</issueManagement>

<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<phantomjs.executable>phantomjs</phantomjs.executable>
</properties>

<scm>
<connection>scm:git:git://github.com/biouno/uno-choice-plugin.git</connection>
<developerConnection>scm:git:git@github.com:biouno/uno-choice-plugin.git</developerConnection>
<url>http://github.com/biouno/uno-choice-plugin</url>
<tag>HEAD</tag>
</scm>

<!-- get every artifact through repo.jenkins-ci.org, which proxies all the
artifacts that we need -->
<repositories>
<repository>
<id>repo.jenkins-ci.org</id>
<url>http://repo.jenkins-ci.org/public/</url>
</repository>
</repositories>
<connection>scm:git:git://github.com/jenkinsci/active-choices-plugin.git</connection>
<developerConnection>scm:git:git@github.com:jenkinsci/active-choices-plugin.git</developerConnection>
<url>http://github.com/jenkinsci/active-choices-plugin</url>
<tag>HEAD</tag>
</scm>

<pluginRepositories>
<pluginRepository>
<id>repo.jenkins-ci.org</id>
<url>http://repo.jenkins-ci.org/public/</url>
</pluginRepository>
</pluginRepositories>

<distributionManagement>
<repository>
<id>jenkins.repo.release</id>
<name>Repository for Releases</name>
<url>${jenkins.repo.path}/releases</url>
</repository>
<snapshotRepository>
<id>jenkins.repo.snapshot</id>
<name>Repository for Snapshots</name>
<url>${jenkins.repo.path}/snapshots</url>
</snapshotRepository>
</distributionManagement>
<developers>
<developer>
<id>kinow</id>
<name>Bruno P. Kinoshita</name>
<timezone>Pacific/Auckland</timezone>
</developer>
<developer>
<id>imoutsatsos</id>
<name>Ioannis K. Moutsatsos</name>
</developer>
</developers>

<dependencies>
<!-- Scriptler is used to eval Groovy parameters -->
<dependency>
<groupId>org.jenkins-ci.plugins</groupId>
<artifactId>scriptler</artifactId>
<version>2.7</version>
</dependency>
<!-- JQuery is included only once -->
<dependency>
<groupId>org.kohsuke.stapler</groupId>
<artifactId>stapler-adjunct-jquery</artifactId>
<version>1.8.3-0</version>
</dependency>
<dependency>
<groupId>org.mockito</groupId>
<artifactId>mockito-core</artifactId>
<version>1.9.5</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.powermock</groupId>
<artifactId>powermock-module-junit4</artifactId>
<version>1.5.1</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.powermock</groupId>
<artifactId>powermock-api-mockito</artifactId>
<version>1.5.1</version>
<scope>test</scope>
</dependency>
<!-- testing -->
<dependency>
<groupId>org.mockito</groupId>
<artifactId>mockito-core</artifactId>
<version>1.9.5</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.powermock</groupId>
<artifactId>powermock-module-junit4</artifactId>
<version>1.5.1</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.powermock</groupId>
<artifactId>powermock-api-mockito</artifactId>
<version>1.5.1</version>
<scope>test</scope>
</dependency>
</dependencies>

<!-- running JS tests -->
<build>
<plugins>
<plugin>
Expand Down Expand Up @@ -127,4 +118,20 @@
</plugins>
</build>

<!-- get every artifact through repo.jenkins-ci.org, which proxies all the
artifacts that we need -->
<repositories>
<repository>
<id>repo.jenkins-ci.org</id>
<url>http://repo.jenkins-ci.org/public/</url>
</repository>
</repositories>

<pluginRepositories>
<pluginRepository>
<id>repo.jenkins-ci.org</id>
<url>http://repo.jenkins-ci.org/public/</url>
</pluginRepository>
</pluginRepositories>

</project>

0 comments on commit f331821

Please sign in to comment.