Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove status default from README #164

Merged
merged 2 commits into from
Feb 10, 2023
Merged

Remove status default from README #164

merged 2 commits into from
Feb 10, 2023

Conversation

sindrenm
Copy link
Contributor

The “status” input is required to specify and does not have a default, so remove “defaults to completed” from its description.

@boswelja
Copy link
Collaborator

Except it does default to completed

default: "completed"

@sindrenm
Copy link
Contributor Author

sindrenm commented Jan 13, 2023

So it would seem, but what about the rest of its description then?

Defaults to completed if targeting 100% rollout, halted for 0%, and inProgress for anything in between.

Also, if it's marked as required, I would guess it was required to pass it in scripts, which, if it has a default, doesn't make sense. Perhaps I'm just misunderstanding something here, I just find the current combination of description, default and required being true to be confusing.

@boswelja
Copy link
Collaborator

True, the rest of the description is incorrect. The idea of marking it as required with a default parameter is to (hopefully) avoid people passing null, though I'm not sure that's even possible 😅

@sindrenm
Copy link
Contributor Author

Right, that makes sense, except I feel like that should be covered by its “Value”:

One of completed, inProgress, halted, draft

I can change this PR to remove the erroneous description and possibly set “Required” to false if you want, or we can close this and make another. Which do you prefer? 🙂

@boswelja
Copy link
Collaborator

I'm happy for both to be done in one PR if that's easiest for you

@sindrenm
Copy link
Contributor Author

I've updated this PR now. Added a “cannot be null” text to its value, although I personally feel like it's a bit redundant because of the already mentioned allowed values. Nevertheless, it doesn't hurt to have it there.

@boswelja boswelja merged commit 02c72d7 into r0adkll:master Feb 10, 2023
@sindrenm sindrenm deleted the fix/remove-default-status-from-readme branch February 10, 2023 13:32
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants