Skip to content

Commit

Permalink
Merge pull request #1 from jenkinsci/feature/JENKINS-43845
Browse files Browse the repository at this point in the history
[JENKINS-43845] - Decouple EnvInject API from EnvInjectLib
  • Loading branch information
oleg-nenashev committed May 5, 2017
2 parents 6e4ec05 + 3c48ac9 commit 300415c
Show file tree
Hide file tree
Showing 18 changed files with 690 additions and 702 deletions.
24 changes: 24 additions & 0 deletions CHANGELOG.md
@@ -0,0 +1,24 @@
Changelog
===

### 1.0

Release date: Coming soon

* [JENKINS-43845](https://issues.jenkins-ci.org/browse/JENKINS-43845) -
Create EnvInject API Plugin, which provides a shared [Jenkins EnvInject Library](https://github.com/jenkinsci/envinject-lib).
* [JENKINS-43535](https://issues.jenkins-ci.org/browse/JENKINS-43535) -
Provide new version of _EnvInject Library_ utility classes, which are compatible with non-`AbstractProject` job types.
* Extend the migrated utility classes by methods migrated from [EnvInject Plugin](https://github.com/jenkinsci/envinject-plugin/).

#### Developer notes (1.0)

* `EnvInjectAction`, `EnvInjectException`, `EnvInjectLogger` classes stay in the original library due to the compatibility reasons.
* Once a plugin adds dependency on this library, it is recommended to...
* Remove explicit dependency on EnvInject Library
* Replace all usages of the
`org.jenkinsci.lib.envinject.service` package by the new methods offered by the plugin.

### Changes before 1.0

See [EnvInject Library changelog](https://github.com/jenkinsci/envinject-lib/blob/master/CHANGELOG.md).
2 changes: 2 additions & 0 deletions Jenkinsfile
@@ -0,0 +1,2 @@
// Build the plugin using https://github.com/jenkins-infra/pipeline-library
buildPlugin()
22 changes: 22 additions & 0 deletions LICENSE.txt
@@ -0,0 +1,22 @@
The MIT License

Copyright (c) 2012-2017 Gregory Boissinot, Oleg Nenashev, and other Jenkins contributors

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

18 changes: 18 additions & 0 deletions README.md
@@ -0,0 +1,18 @@
EnvInject API Plugin
===

This is an API plugin, which encapsulates [Jenkins EnvInject Library](https://github.com/jenkinsci/envinject-lib)
and provides additional API for environment variable management within Jenkins plugins.

This API plugin is mainly used in the [EnvInject Plugin](https://plugins.jenkins.io/envinject),
but it can be used in other plugins as well.
As an API plugin, it guarantees backward compatibility of API and does not contribute any user-visible components by default.

## Documentation

* [Changelog](CHANGELOG.md)
* [Plugin Javadoc](http://javadoc.jenkins.io/plugin/envinject-api/)

## License

[MIT License](https://opensource.org/licenses/mit-license.php)
120 changes: 57 additions & 63 deletions pom.xml
@@ -1,76 +1,70 @@
<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>
<modelVersion>4.0.0</modelVersion>

<parent>
<groupId>org.jenkins-ci</groupId>
<artifactId>jenkins</artifactId>
<version>1.29</version>
</parent>
<parent>
<groupId>org.jenkins-ci.plugins</groupId>
<artifactId>plugin</artifactId>
<version>2.26</version>
</parent>

<groupId>org.jenkins-ci.lib</groupId>
<artifactId>envinject-lib</artifactId>
<version>1.25-SNAPSHOT</version>
<packaging>jar</packaging>
<name>Jenkins EnvInject Library</name>
<url>https://wiki.jenkins-ci.org/display/JENKINS/EnvInject+Plugin</url>
<artifactId>envinject-api</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>jar</packaging>
<name>EnvInject API Plugin</name>
<description>Stores shared logic for Environment Injection management</description>
<url>https://wiki.jenkins-ci.org/display/JENKINS/EnvInject+API+Plugin</url>

<licenses>
<license>
<name>MIT license</name>
<comments>All source code is under the MIT license.</comments>
</license>
</licenses>
<licenses>
<license>
<name>MIT License</name>
<url>http://www.opensource.org/licenses/mit-license.php</url>
<distribution>repo</distribution>
</license>
</licenses>

<developers>
<developer>
<id>gbois</id>
<name>Gregory Boissinot</name>
<timezone>+1</timezone>
<roles>
<role>Project Owner</role>
<role>Project Lead Developer</role>
</roles>
</developer>
</developers>
<developers>
<developer>
<id>oleg_nenashev</id>
<name>Oleg Nenashev</name>
<timezone>+1</timezone>
</developer>
</developers>

<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<maven.compiler.source>1.6</maven.compiler.source>
<maven.compiler.target>1.6</maven.compiler.target>
<jenkins.core.version>1.532</jenkins.core.version>
</properties>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<java.level>7</java.level>
<jenkins.version>1.625.3</jenkins.version>
</properties>

<scm>
<connection>scm:git:git://github.com/jenkinsci/envinject-lib.git</connection>
<developerConnection>scm:git:git@github.com:jenkinsci/envinject-lib.git</developerConnection>
<tag>HEAD</tag>
<scm>
<connection>scm:git:ssh://github.com/jenkinsci/${project.artifactId}-plugin.git</connection>
<developerConnection>scm:git:ssh://git@github.com/jenkinsci/${project.artifactId}-plugin.git</developerConnection>
<url>https://github.com/jenkinsci/${project.artifactId}-plugin</url>
<tag>HEAD</tag>
</scm>

<dependencies>
<dependency>
<groupId>org.jenkins-ci.lib</groupId>
<artifactId>envinject-lib</artifactId>
<version>1.25</version>
</dependency>
</dependencies>

<dependencies>
<repositories>
<repository>
<id>repo.jenkins-ci.org</id>
<name>Jenkins Repository</name>
<url>https://repo.jenkins-ci.org/public/</url>
</repository>
</repositories>

<dependency>
<groupId>org.jenkins-ci.main</groupId>
<artifactId>jenkins-core</artifactId>
<version>${jenkins.core.version}</version>
<scope>provided</scope>
</dependency>

</dependencies>

<repositories>
<repository>
<id>repo.jenkins-ci.org</id>
<name>Jenkins Repository</name>
<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>
<pluginRepositories>
<pluginRepository>
<id>repo.jenkins-ci.org</id>
<url>https://repo.jenkins-ci.org/public/</url>
</pluginRepository>
</pluginRepositories>

</project>
185 changes: 0 additions & 185 deletions src/main/java/org/jenkinsci/lib/envinject/EnvInjectAction.java

This file was deleted.

0 comments on commit 300415c

Please sign in to comment.