publishChecks step: the conclusion should be none when status is not completed

[XiongKezhi]

Currently, the publishChecks step has a default success value for the conclusion, however, it should reset the conclusion to be none when the status is queued or in_progress. Otherwise, users may have to explicitly set the conclusion to be none since, like GitHub, it will automatically set the status to be completed when conclusion is provided.

See the context: #70 (comment)

[ThusithaDJ]

Hi @XiongKezhi, If this fix is not super urgent, can I work on this?

[XiongKezhi]

go ahead! thanks!

[ThusithaDJ]

@XiongKezhi, is this issue fixed, or am I checking at the wrong place?

checks-api-plugin/src/main/java/io/jenkins/plugins/checks/status/BuildStatusChecksPublisher.java

Lines 128 to 129 in 64dc0a6

	getChecksName(job).ifPresent(checksName -> publish(ChecksPublisherFactory.fromJob(job, TaskListener.NULL),
	ChecksStatus.QUEUED, ChecksConclusion.NONE, checksName, null));

checks-api-plugin/src/main/java/io/jenkins/plugins/checks/status/BuildStatusChecksPublisher.java

Lines 152 to 153 in 64dc0a6

	getChecksName(run).ifPresent(checksName -> publish(ChecksPublisherFactory.fromRun(run, listener),
	ChecksStatus.IN_PROGRESS, ChecksConclusion.NONE, checksName, null));

[KalleOlaviNiemitalo]

BuildStatusChecksPublisher is the wrong place. You need PublishChecksStep.

[ThusithaDJ]

Thanks, @KalleOlaviNiemitalo. To be clear, I shouldn't change the conclusion variable's default value but need to add a condition to check whether status is queued or in_progress, right?

[KalleOlaviNiemitalo]

I don't really know what is the best way to implement this. Anyway, please test that the pipeline snippet generator behaves in a sensible way after your changes.

[XiongKezhi]

Thanks, @KalleOlaviNiemitalo. To be clear, I shouldn't change the conclusion variable's default value but need to add a condition to check whether status is queued or in_progress, right?

yes, you should add a condition to check the status when setting the conclusion.

[ThusithaDJ]

Ok sure. Thanks a lot, both of you.

[ThusithaDJ]

@XiongKezhi, could you please let me know if you have any guide to follow on setting up the plugin for local testing? I referred to the Consumers Guide and Implementation Guide, but it's a bit unclear for me. It would be better if you can help me with this.

[XiongKezhi]

@ThusithaDJ Sorry, those are not guides for users, they are for other plugin developers.

So when you are trying to test this plugin locally, first you need to set up a Jenkins instance for remote debugging. If you are using a Jenkins war file, startup it with the java options like (for more, see here):

-Xdebug -Xrunjdwp:transport=dt_socket,address=127.0.0.1:8000,server=y,suspend=n

Then you can set up your remote debugger to attach to it.

Finally, you need a Jenkins project to run the code of this plugin:

1. Set up the GitHub app credentials as in this guide
2. Use the GitHub app credentials you added to Jenkins in the last step in one of your projects. I have a multi-branch project set up like this (you should use the repository that your GitHub app is installed on):

And since you are going to modify the publishChecks step, so you should have a repository with a Jenkins pipeline calling publishChecks.

[timja]

personally I just change the dependency in the github checks repo to a SNAPSHOT dependency, build this project with mvn install -P quick-build and then run the github checks project with mvn hpi:run using the debug option in my IDE

or just using unit tests for some changes where I don't actually need GitHub

[ThusithaDJ]

Hi @XiongKezhi, I have pushed some changes, please check that and let me know your thoughts.
#82

[XiongKezhi]

fixed by #82