jenkinsci
/
configuration-as-code-plugin
mirror of https://github.com/jenkinsci/configuration-as-code-plugin.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

improve requirements doc 

Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
This commit is contained in:
Nicolas De Loof 2018-10-08 12:15:22 +02:00
parent 9225585c77
commit 2dc5e3518c
No known key found for this signature in database
GPG Key ID: 9858809D6F8F6E7E
1 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/REQUIREMENTS.md
View File

@ -50,23 +50,31 @@ to be replaced by :
```java ```java
public boolean configure(StaplerRequest req, JSONObject json) throws FormException { public boolean configure(StaplerRequest req, JSONObject json) throws FormException {
try (BulkChange bc = new BulkChange(this)) {
req.bindJSON(this, json); req.bindJSON(this, json);
save(); bc.commit();
}
return true; return true;
} }
@DataBoundSetter @DataBoundSetter
public void setSmtpHost(String smtpHost) { public void setSmtpHost(String smtpHost) {
this.smtpHost = nullify(smtpHost); this.smtpHost = nullify(smtpHost);
save();
} }
@DataBoundSetter @DataBoundSetter
public void setReplyToAddress(String address) { public void setReplyToAddress(String address) {
this.replyToAddress = Util.fixEmpty(address); this.replyToAddress = Util.fixEmpty(address);
save();
} }
``` ```
note: you might not even need to implement `configure` once [#3669](https://github.com/jenkinsci/jenkins/pull/3669) notes:
- you also need matching getters for jelly view to render current value, but you probably already have them declared.
- use of BulkChange allows to avoid repeated calls to `save()` to actually persist to disk only once fully
configured.
- you might not even need to implement `configure` once [#3669](https://github.com/jenkinsci/jenkins/pull/3669)
is merged. is merged.
### Rule 2: don't use pseudo-properties for optional ### Rule 2: don't use pseudo-properties for optional