-
Task
-
Resolution: Fixed
-
Minor
-
None
Since version 2.0, the Mattermost Plugin no longer has a field showCommitList.
This leads to Jenkins finding "unreadable data":
MissingFieldException: No field 'showCommitList' found in class 'jenkins.plugins.mattermost.MattermostNotifier'
Instead, there's now a field commitInfoChoice, which is an enum with (currently) three possible values NONE, AUTHORS, or AUTHORS_AND_TITLES.
I've also looked at the new generic DSL version, but going from
mattermost {
endpoint(MATTERMOST_HOOK_URL)
notifyFailure()
}
to
mattermostNotifier {
endpoint(MATTERMOST_HOOK_URL)
room(null)
icon(null)
buildServerUrl(null)
sendAs(null)
startNotification(false)
notifyAborted(false)
notifyFailure(true)
notifyNotBuilt(false)
notifySuccess(false)
notifyUnstable(false)
notifyBackToNormal(false)
notifyRepeatedFailure(false)
includeTestSummary(false)
commitInfoChoice('NONE')
includeCustomMessage(false)
customMessage(null)
}
is not exactly an attractive proposition (undocumented, no IDE support, can't leave out default valued fields, very little advantage over a configure block).
[JENKINS-39239] Mattermost Plugin 2.0+: No field 'showCommitList'
Henning Hoefer
created issue -
Daniel Spilker
made changes -
| Component/s | New: mattermost-plugin [ 21021 ] |
Daniel Spilker
made changes -
| Assignee | Original: Daniel Spilker [ daspilker ] | New: Jo Vandeginste [ jovandeginste ] |
I did some digging, and it seems the slack-plugin I'm basing the mattermost-plugin has this commit:
https://github.com/jenkinsci/slack-plugin/commit/a0d92735557263c49482103045748a890e05d55e
Did we forget to include a part from the slack-plugin? Or do (should) they suffer the same problem?
I'll have a look at the DSL thing.
Daniel Spilker
added a comment - From what I see in that commit, the Slack plugin should have the same problem. You can simply add a private transient boolean showCommitList field to MattermostNotifier to fix this. This affects all users, not only Job DSL users.
It would be great if you could change the @DataBoundConstructor to only take the mandatory options and move all optional settings to @DataBoundSetters. I can review your changes to see if it works if you like.
Daniel Spilker
added a comment - From what I see in that commit, the Slack plugin should have the same problem. You can simply add a private transient boolean showCommitList field to MattermostNotifier to fix this. This affects all users, not only Job DSL users.
It would be great if you could change the @DataBoundConstructor to only take the mandatory options and move all optional settings to @DataBoundSetters . I can review your changes to see if it works if you like. That would be really great.
I added the transient option already (not yet pushed to repository), and am trying to write all the setters. I'm trying to figuring out when the fixNull is relevant – I seem to understand it's not relevant for booleans...
I'll update this ticket when I push my code to github, and will kindly ask you to review 
mvn verify is running, but the changes are in this branch:
https://github.com/jovandeginste/jenkins-mattermost-plugin/commits/jenkins-39239
I fixed the failures - the commit url is obviously no longer the same. I appreciate any feedback at this point.
Daniel Spilker
added a comment - Works as expected, nice!
I redirect this to the Mattermost plugin.
A plugin must not remove a field to retain backwards compatibility, see https://wiki.jenkins-ci.org/display/JENKINS/Hint+on+retaining+backward+compatibility.
And the automatically generated DSL does require all options because the Mattermost plugin marks the options as mandatory by using a @DataBoundConstructor instead of @DataBoundSetter. This also affects the Pipeline DSL, see https://github.com/jenkinsci/pipeline-plugin/blob/master/DEVGUIDE.md#constructor-vs-setters.