Pipeline plugin compatibility (Formerly Workflow plugin)

[leth]

I'd be great if we could use this plugin from a Jenkinsfile!

The plugin repo has a compatibility guide.

[scaytrase]

How does this handle credentials?

[leth]

It looks like they reference them by ID, e.g:

git url: 'git@git.local.domain:ps/project.git', credentialsId: '67c3072d-b9a7-44fa-a5aa-560ba9c1662f'

[jglick]

Probably suffices to implement SimpleBuildStep and replace AbstractBuild with Run everywhere, skipping calls to TokenMacro if not in fact passed an AbstractBuild.

[lindt]

is there any known possible workaround?

Something like?

sh 'curl https://stash..../foo'

[scaytrase]

Sure, yes, you could just use official stash\bitbucket server documentation

https://developer.atlassian.com/stash/docs/latest/how-tos/updating-build-status-for-commits.html

[stchar]

Hi,
Does anyone is working on this? If not please assign it to me

[stchar]

BTW @scaytrase,
whats the target branch should be? master or relase1.0 I see some refactoring on the master but new classes are not currently in use.

[scaytrase]

Use default branch (release/1.x currently) as target

[stchar]

To all who are interested in.

I believe that the usage of stash notifier plugin in pipeline should be changed.
I think that behavior can be same as in the email plugin.
You can notify stash any time with any status for any repository you want.

So you add a step in the beginning of the build section and insert

step([$class: 'StashNotifier', buildState: 'INPROGRESS', commitSha1: 'bbbb', credentialsId: '', disableInprogressNotification: false, ignoreUnverifiedSSLPeer: false, includeBuildNumberInKey: false, prependParentProjectKey: false, projectKey: 'cccc', stashServerBaseUrl: 'aaaa'])

On failure you just catch the error
like

stage 'build'
try {
     sh 'do the build'
} catch (e) {
     step([$class: 'StashNotifier', buildState: 'FAILED', commitSha1: 'bbbb', credentialsId: '', disableInprogressNotification: false, ignoreUnverifiedSSLPeer: false, includeBuildNumberInKey: false, prependParentProjectKey: false, projectKey: 'cccc', stashServerBaseUrl: 'aaaa'])
     error e
}

On success you send

step([$class: 'StashNotifier', buildState: 'SUCCESS', commitSha1: 'bbbb', credentialsId: '', disableInprogressNotification: false, ignoreUnverifiedSSLPeer: false, includeBuildNumberInKey: false, prependParentProjectKey: false, projectKey: 'cccc', stashServerBaseUrl: 'aaaa'])

Overall the snippet generator might look like this

I'm free for any other ideas. Just let me know.

[scaytrase]

Could you post a sample build file to represent the case-branching model (inprogress, fail, success)

[stchar]

@scaytrase, sure, will do it later. Now I have to get back to work.

[scaytrase]

Okey, just wan't to see how it will look like to give opinion. I've personally dislike the idea to store so much information in scripts (too much coupling to the infrastructue)

[nickbroon]

There appears to be Github Commit Status Notifier step that seems very similar, that can can be used from the Snippet editor.

step([$class: 'GitHubCommitStatusSetter', commitShaSource: [$class: 'ManuallyEnteredShaSource', sha: '123456'], statusResultSource: [$class: 'ConditionalStatusResultSource', results: [[$class: 'AnyBuildResult', message: 'Foo Bar', state: 'FAILURE']]]])

https://github.com/jenkinsci/github-plugin/blob/master/src/main/java/com/cloudbees/jenkins/GitHubSetCommitStatusBuilder.java

It would probably be good to model it on that.

[stchar]

@scaytrase
I keep in mind following snippet:

node('master') {
    _WORKSPACE=pwd()
    for ( repository in ['repository1', 'repository2', 'repository3'] ) {

        stage repository+'-verification'    // repository1-verification

        dir(_WORKSPACE+'/'+repository) {

             git "https://mybb.org/project/${repository}.git"

             // Somehow get commit sha1             
             notify(repository,'aabbcc','INPROGRESS')

             try {
                 echo 'do the build/test/whatever'
             } catch (e) {
                   notify(repository,'aabbcc','FAILED')
               error e
             }
             notify(repository,'aabbcc','SUCCESS')
         }
    }
}

def notify(repository,sha1,status) {
    step([$class: 'StashNotifier', 
    buildState: status, 
    commitSha1: sha1, 
    credentialsId: '1111-2222-3333-4444', 
    disableInprogressNotification: false, 
    ignoreUnverifiedSSLPeer: false, 
    includeBuildNumberInKey: false, 
    prependParentProjectKey: false, 
    projectKey: 'myproject',
    repositoryKey: repository,     // new argument as it's not clear how to get git url in workflow
    stashServerBaseUrl: 'https://mybb.org'])
 }

[scaytrase]

repositoryKey: repository, // new argument as it's not clear how to get git url in workflow

What for? StashBaseUrl + CommitSha1 should be enought to notify.

[Faheetah]

How do we even derive the commit hash from pipelines? JENKINS-34455 gives a workaround using shell but pipelines don't expose a commit hash variable from what I can see, even though the job recognizes one.

[scaytrase]

When building classic build steps, commit sha1 is known from the ENV. When using suggested

 git "https://mybb.org/project/${repository}.git"

it could be obtained from workdir, i think

[tmds]

@headcrabmeat, any idea when we can expect this feature?

[tmds]

Is someone working on this issue? Is there a workaround?

[scaytrase]

Workaround is proposed to pipeline plugin

jenkinsci/pipeline-examples#21

[stchar]

@tmds
It's hard to say. I still do not have a working code. All I can say is that I'm motivated to implement it's asap, as I want to use a plugin instead of workaround.

[tmds]

@headcrabmeat good to hear you are still on the issue! Depending on where you are it may be usefull to initiate a pull request and get some feedback even if things aren't working yet.

[stchar]

@tmds, @scaytrase,
Created PR #108.
Comments are welcome.

[tmds]

@scaytrase can you review the PR?

[scaytrase]

I think there is nothing to review until tests pass. Everything could change. I'm keeping eye on it, don't worry. The patch is full of temporary changes, I think @headcrabmeat let us know when he is ready

[tmds]

@headcrabmeat the pipeline-examples has an example to get the commit sha:
https://github.com/jenkinsci/pipeline-examples/blob/912c73791fdc1a6faa1ab159c4719e33eba18688/pipeline-examples/gitcommit/gitcommit.groovy

[scaytrase]

Not the best example, as for me. Very platform dependent, requires sh, git in path (Jenkins has jgit as option), creates temporary files

[tmds]

Not the best example, as for me. Very platform dependent, requires sh, git in path (Jenkins has jgit as option), creates temporary files

Only example so far and good as a starting point.

[stchar]

Thanks guys, I was told that env object can be used as well. I will try it soon.

[coder-hugo]

I implemented such a build step a few weeks ago for the gitlab-plugin. You can have a look at the GitLabCommitStatusStep as an example how to do this.

[scaytrase]

Implemented with #115