Build: report "Build canceled" when sending VCS build status' description for a particular commit

[pllim]

Example: astropy/astropy#12928

PR status: docs/readthedocs.org:astropy Pending — Read the Docs build is in progress!

But when you click on "Details", it goes to https://readthedocs.org/projects/astropy/builds/16281860/ that says Error - Build cancelled by user.

Expectation: PR status says "build has been canceled by user" or something to that effect with a ❌ .

[humitos]

Hi @pllim! I'm not able to reproduce this issue. I tried with our testing project and it worked as you expect readthedocs/test-builds#2082

Does the Github status report work properly for your project usually? I saw a message in the logs saying that there were permissions problems and the status wasn't able to be sent.

[pllim]

I think usually it works. I'll keep an eye out and report back though .

[stsewd]

The message says the build failed

docs/readthedocs.org:test-builds — Read the Docs build failed!

I think it is better if the message says the build was cancelled instead.

[pllim]

Yes, now it reports back as failed. Maybe what I originally reported was transient.

I think it is better if the message says the build was cancelled instead.

I completely agree. That would be more consistent with other CI providers. Thanks!

[humitos]

Related to #9040

[humitos]

To make this possible, the code needs some refactoring. Currently, we are only sending the state (failed, pending, success) and we use a constant SELECT_BUILD_STATUS to find the description to be sent. However, we would need either:

• pass the reason to the function that sends the message (

  readthedocs.org/readthedocs/oauth/services/github.py

  Lines 438 to 439 in ca4b3c7

  	github_build_state = SELECT_BUILD_STATUS[state]['github']
  	description = SELECT_BUILD_STATUS[state]['description']

  )
• pass the description itself when the function is called

To do this, we need to modify the util function, the task, and both service methods at least.

[zmbc]

Beyond just the message, it is surprising to me that cancelling the build returns a failure status. I know that GitHub Actions for instance can return a "cancelled" status, which doesn't have a red X that makes things look like they failed. Is that a feature GitHub allows third-party tools to use? Or, could it make more sense to just leave the status as pending?