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

Update cmd description #24

Closed

Conversation

rikhuijzer
Copy link
Contributor

I don't see a reason in the action.yml why version is mandatory to use cmd.

@DilumAluthge
Copy link
Member

Suppose that the user adds a cmd of the form CompatHelper.main(; foo = ...). Since the user has not specified the version, it will use the default version = '3'.

Now suppose that I release CompatHelper 4.0.0, which removed the foo kwarg, which is perfectly fine to do in a major release.

Now, here's the tricky part. I want to be able to easily upgrade the Julia ecosystem to CompatHelper v4, so I edit the action.yml file in this repo to change the default from version = '3' to version = '4'. But, I don't want everyone to have to edit their CompatHelper.yml files, so I make this change in the v1 tag of this repo.

But now the action is broken for the user that was doing a custom cmd.

So most users don't need to set version. But if a user sets cmd, they must set version to prevent the action from suddenly breaking.

@rikhuijzer
Copy link
Contributor Author

You're right

@rikhuijzer rikhuijzer closed this Sep 1, 2022
@rikhuijzer rikhuijzer deleted the rh/cmd-description branch September 1, 2022 07:28
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.

None yet

2 participants