error_count input name is confusing

[TWiStErRob]

    steps:
      - name: "Deploy to GitHub Pages"
        id: deployment
        uses: actions/deploy-pages@v2
        with:
          error_count: 0

I might've mis-interpreted the error_count when initially configuring the action. I want to allow no errors, however based on the below log this error_count seems to mean deployment_in_progress_poll_count or something like it.

Created deployment for b6872282209cb2c94d458dcc594dfddd82d733b9, ID: b6872282209cb2c94d458dcc594dfddd82d733b9
Getting Pages deployment status...
Current status: syncing_files
Error: Too many errors, aborting!
Error: Failed with status code: 0
Canceling Pages deployment...
Canceled deployment with ID b6872282209cb2c94d458dcc594dfddd82d733b9

[JamesMGreene]

There's a brief parameter description included in the Action manifest:

deploy-pages/action.yml

Lines 16 to 17 in 03b62d1

	error_count:
	description: 'Maximum number of status report errors before cancelling a deployment (default: 10)'

Fair misunderstanding, especially since we shouldn't really allow error_count: 0. That causes the action to fail even if there are 0 errors when it does the check. 😅 🤦

The behavior you're describing would be achieved by error_count: 1, as in "fail on the first error".

I see you also found a similar write-up in:

• Add sanitization, validation, and basic tests for the error_count input parameter #172 (comment)

We may consider revising the naming but, for now, error_count: 1 achieves the desired behavior.

Apologies for the confusion! ❤

[TWiStErRob]

Thanks, makes sense.

It's the good old "threshold problem". Over at detekt we also had similar problems and they're being renamed in the upcoming major to clarify.

I'm curious if this issue will get more upvotes in the coming year, especially if/when this upload approach goes out of beta and adoption grows.

[JamesMGreene]

I'm curious if this issue will get more upvotes in the coming year, especially if/when this upload approach goes out of beta and adoption grows.

Oh, we're waaaaay out of beta. 😅 This action is involved in more than 2 million Pages deployments per week.

We might be open to renaming the parameter in a future major release, though. 🤷
Any naming suggestions?

[TWiStErRob]

I was referring to this "Beta":

I think you said it best

error_count: 1, as in "fail on the first error".

i.e. fail_on_error_count: 5

I think maybe: allowed_status_failures: 4 would be an even better name. But it implies that during migration users have to subtract one from their config. Default can stay as it doesn't really matter if it fails on 10th or 11th.

Another alternative could be status_report_retries: 4.

[JamesMGreene]

Sorry to be wishy-washy, but I'm going to reopen this so the feedback isn't lost. 😅

[TWiStErRob]

Sorry to be wishy-washy, but I'm going to reopen this so the feedback isn't lost. 😅

Up to you how to handle this. Feedback is a weird thing, it's not always actionable 😇