[JENKINS-43535,, JENKINS-43845] - Add documentation to the library

jenkinsci · Apr 26, 2017 · 94a7952 · 94a7952
1 parent 36006bd
commit 94a7952
Show file tree

Hide file tree

Showing 3 changed files with 75 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,33 @@
+Changelog
+===
+
+### 1.25
+
+Release date: Coming soon
+
+* [JENKINS-43845](https://issues.jenkins-ci.org/browse/JENKINS-43845) -
+Deprecate obsolete utility methods in the library.
+Methods have been moved to the [EnvInject API Plugin](https://plugins.jenkins.io/envinject-api).
+* [JENKINS-43535](https://issues.jenkins-ci.org/browse/JENKINS-43535) - 
+Make `EnvInjectAction` API compatible with non-`AbstractProject` job types like Jenkins Pipeline
+
+#### Developer notes
+
+* Starting from this version, the library should not be directly used by plugins
+  * Use dependency on the [EnvInject API Plugin](https://plugins.jenkins.io/envinject-api) instead.
+  * Remove explicit dependency on the EnvInject Library.
+  * Replace all usages of the 
+`org.jenkinsci.lib.envinject.service` package by the new methods offered by the plugin. 
+
+# 1.24
+
+Release date: _Jul 01, 2016_
+
+* [JENKINS-36184](https://issues.jenkins-ci.org/browse/JENKINS-36184) - 
+Remove implicit dependency on the [Matrix Project Plugin](https://plugins.jenkins.io/matrix-project), 
+which has been detached from the core.
+It was causing regressions in Jenkins installations without this plugin.
+
+### Changes before 1.24
+
+See the commit history
diff --git a/LICENSE.txt b/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.
+
diff --git a/README.md b/README.md
@@ -0,0 +1,20 @@
+Jenkins EnvInject Library
+===
+
+Provides basic API for declaring and retrieving environment variables in Jenkins builds.
+
+## Usage
+
+Starting from `1.25` this library is provided via in the [EnvInject API Plugin](https://plugins.jenkins.io/envinject-api) and should not be used as a direct dependency in Jenkins plugins.
+The library guarantees backward compatibility of API and does not contribute any user-visible components by default.
+
+You can see usage examples in the [EnvInject Plugin](https://plugins.jenkins.io/envinject).
+
+## Documentation
+
+* [Changelog](CHANGELOG.md)
+* [EnvInject API Plugin Documentation](https://github.com/jenkinsci/envinject-api-plugin/) - migrated API documentation
+
+## License
+
+[MIT License](https://opensource.org/licenses/mit-license.php)