Add sanitization, validation, and basic tests for the `reporting_interval` input parameter

Open
#171 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
github-actions, javascript
Domain
ci-cd, devops

Research direction

Review PR #170 for the existing timeout sanitization and validation approach, then check issue #172 for related context. Locate the reporting_interval input handling and add basic tests covering finite, positive values and values below the finalized timeout; done means those rules are enforced and tested.

Written by the indexing model from the issue text.

Description

enhancement

Add sanitization, validation, and basic tests for the reporting_interval input parameter.

Some possible rules:

  • ensure it is a finite number
  • ensure it is greater than 0 (we default to 5, as a point of reference)
  • ensure it is less than the finalized timeout input parameter value (which may be adjusted to MAX_TIMEOUT, depending on the user's input), otherwise it will never run

Similar to the a part of the changes made for timeout as shown in PR:

  • #170

See also:

  • #172
Dominant language
JavaScript
Stars
967
Forks
147
PR merge metrics
No merged PRs in 30d

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from actions/deploy-pages

All issues in actions/deploy-pages

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.