Use deployments API instead of commit status

[timja]

No description provided.

[halkeye]

So again, why? what does deployments do that checks don't in this case?

looking at https://docs.github.com/en/rest/reference/repos#create-a-deployment (and https://octokit.github.io/rest.js/v18#repos-create-deployment) it looks like creating a deployment triggers events for other systems to use? is that right?

Would you create a deployment before anything starts,
set the status to pending (https://docs.github.com/en/rest/reference/repos#create-a-deployment-status)
then do all the work
then set the status to completed (https://docs.github.com/en/rest/reference/repos#create-a-deployment-status)?

[timja]

Deployments is more obvious than a commit status I think, it separates it out from the other checks and is an explicit release I think.

You would create a deployment once the zip has been uploaded to incrementals app and before it’s been uploaded to artifactory I think

[halkeye]

I can certainly look into it, might be a good hacktober thing too.

Do you have an exmaple repo with deployments happening? i couldn't find one to see how it worked.

Otherwise i'll prototype something down the line.

[timja]

hmcts/rpe-pdf-service#271

https://github.com/hmcts/cnp-jenkins-library/blob/master/vars/githubCreateDeployment.groovy
https://github.com/hmcts/cnp-jenkins-library/blob/master/vars/githubUpdateDeploymentStatus.groovy

[jglick]

also see https://issues.jenkins.io/browse/JENKINS-52116

[jglick]

To be clear, #21 closes this effectively as “will not fix”.

[timja]

To be clear, #21 closes this effectively as “will not fix”.

Yeah, a better alternative I think.