Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
[JENKINS-28946] - JIRA support for Workflow jobs
- Loading branch information
Showing
15 changed files
with
598 additions
and
166 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
# Plugin Compatibility with [Workflow](https://github.com/jenkinsci/workflow-plugin) | ||
|
||
This document captures the status of features to be compatible or incompatible. | ||
|
||
##JiraIssueUpdater usage example | ||
|
||
You need keep reference to used scm. | ||
As an example, you can write a flow: | ||
|
||
```groovy | ||
node { | ||
def gitScm = git url: 'git@github.com:jenkinsci/jira-plugin.git', branch: 'master' | ||
sh 'make something' | ||
step([$class: 'hudson.plugins.jira.JiraIssueUpdater', | ||
issueSelector: [$class: 'hudson.plugins.jira.DefaultUpdaterIssueSelector'], | ||
scm: gitScm]) | ||
gitScm = null | ||
} | ||
``` | ||
|
||
Note that a pointer to scm class should be better cleared to not serialize scm object between steps. | ||
|
||
You can add some labels to issue in jira: | ||
```groovy | ||
step([$class: 'hudson.plugins.jira.JiraIssueUpdater', | ||
issueSelector: [$class: 'hudson.plugins.jira.DefaultUpdaterIssueSelector'], | ||
scm: gitScm, | ||
labels: [ "$version", "jenkins" ]]) | ||
``` | ||
|
||
## Other features | ||
|
||
Some features are currently not supported in workflow. | ||
If you are adding new features please make sure that they support Jenkins Workflow Plugin. | ||
See [here](https://github.com/jenkinsci/workflow-plugin/blob/master/COMPATIBILITY.md) for some information. | ||
See [here](https://github.com/jenkinsci/workflow-plugin/blob/master/basic-steps/CORE-STEPS.md) for more information how core jenkins steps integrate with workflow jobs. | ||
|
||
Running a notifiers is trickier since normally a flow in progress has no status yet, unlike a freestyle project whose status is determined before the notifier is called (never supported). | ||
So notifiers will never be implemented as you can use the catchError step and run jira action manually. | ||
I'm going to create a special workflow steps to replace this notifiers in future. | ||
|
||
Other builders will be supported in future (not supported yet). | ||
|
||
##Current status: | ||
|
||
- [X] `JIRA Issue Parameter` supported | ||
- [X] `Jira Version Parameter` supported | ||
- [X] `JiraChangeLogAnnotator` supported | ||
- [X] `JiraIssueUpdater` supported | ||
- [ ] `JiraIssueUpdateBuilder` not supported yet | ||
- [ ] `JiraCreateReleaseNotes` not supported yet | ||
- [ ] `JiraCreateIssueNotifier` never supported | ||
- [ ] `JiraIssueMigrator` never supported | ||
- [ ] `JiraReleaseVersionUpdater` never supported | ||
- [ ] `JiraReleaseVersionUpdaterBuilder` not supported yet | ||
- [ ] `JiraVersionCreator` never supported |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.