jenkinsci / jenkinsci/description-setter-plugin
[JENKINS-5890] Failed Run Description not set with a blank failed regex - The help message is misleading
- Dominant language
- Java
- Stars
- 17
- Forks
- 40
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 1
Description
The third description-setter option is "Regular expression for failed builds". The help says
"If set, this regular expression will be used instead of the regular regular expression when the build has failed."
So I left this field blank expecting the set Regular Expression to be applied to all runs. But it turns out it is only set for Successful runs.
Filling out the failed regrex works and the description gets properly set for failed runs.
This bug can be fixed by updating the help or making the behavior match the existing help.
I prefer updating the behavior. If someone does not want descriptions set for failed builds they can set the field to an empty string. Or maybe have a checkbox so you can choose setting description of failed builds.
Nice plugin by the way.
---
Originally reported by jminne, imported from: Failed Run Description not set with a blank failed regex - The help message is misleading
Raw content of original issue
The third description-setter option is "Regular expression for failed builds". The help says
"If set, this regular expression will be used instead of the regular regular expression when the build has failed."So I left this field blank expecting the set Regular Expression to be applied to all runs. But it turns out it is only set for Successful runs.
Filling out the failed regrex works and the description gets properly set for failed runs.
This bug can be fixed by updating the help or making the behavior match the existing help.
I prefer updating the behavior. If someone does not want descriptions set for failed builds they can set the field to an empty string. Or maybe have a checkbox so you can choose setting description of failed builds.
Nice plugin by the way.
environment
```
Hudson ver. 1.346
Hudson description setter plugin ver. 1.6
```
Contributor guide
Research direction
Start by locating the description-setter-plugin code that selects the regular expression for successful and failed builds, then reproduce the behavior with the failed-build regex left blank. Compare the implementation with the documented help text and verify that the chosen fix makes blank-field behavior consistent, including regression coverage if the project provides tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- ci-cd
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100