Add link to plugin developers guide from README (#1417)

Co-authored-by: Tim Jacomb <t.jacomb@kainos.com>
This commit is contained in:
Alberto Scotto 2020-06-09 12:41:39 +02:00 committed by GitHub
parent 319b642b06
commit 91eef62109
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 0 deletions

View File

@ -244,6 +244,10 @@ Kubernetes users:\
Most plugins should be supported out-of-the-box, or maybe require some minimal changes. See this [dashboard](https://issues.jenkins.io/secure/Dashboard.jspa?selectPageId=18341) for known compatibility issues.
## Adding JCasC support to a plugin
Plugin developers wanting to support JCasC in their plugin should [check out our how-to guide](docs/PLUGINS.md).
## Compatibility with Jenkins >= 2.199 for JCasC < 1.36
Jenkins 2.199 introduced [a check to prevent saving global configuration before loading the configuration has occurred](https://github.com/jenkinsci/jenkins/pull/4171). Configurations As Code needs to apply global configuration before Jenkins loads jobs (so they can load and correctly reference any global state) and as such there exists a race condition where by Jenkins may fail to start when used with this plugin.