cake-build / cake-action

:cake::octocat: Run Cake (C# Make) scripts in your GitHub Actions workflows.

Home Page:https://cakebuild.net

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Add support for implicit bootstrapping of modules

ecampidoglio opened this issue · comments

As of cake-build/cake#2849, modules are automatically bootstrapped before running the script. While it's still possible to do it explicitly with the --bootstrap option, it's no longer necessary. Instead, a new option has been introduced to opt out of the bootstrapping process called --skip-bootstrap.

The Cake action should reflect these changes both in the code and in the documentation.

@ecampidoglio what if I chose to set cake-version to 0.38.5? I would need the "old" --bootstrap option. Would it be possible to change the cake-bootstrap setting to accept

  • bootstrap (equivalent to true for compatibility) to pass --bootstrap and
  • skip to pass --skip-bootstrap.

The documentation for this, then, should state that setting cake-bootstrap: bootstrap is only valid for Cake versions < 1.0.0 and, in turn, setting cake-bootstrap: skip is only valid for Cake versions >= 1.0.0.

0.* going out of support in a week or so, perhaps that concern can be skipped?

I think you should be able to run any version of Cake via the action (that's what the cake-version parameter is for). This means supporting older versions.

Since we're releasing version 2.0.0 to address #41, we might as well take the opportunity to introduce other breaking changes.

How about we change the cake-bootstrap parameter from a boolean to a three-state switch:

cake-bootstrap: auto # The current default behavior
cake-bootstrap: explicit # Passes the --bootstrap option for Cake >= 1.0.0
cake-bootstrap: skip # Passes the --skip-bootstrap option for Cake <= 1.0.0

The action could detect the version of Cake being run and ignore the parameter if its current value isn't supported.

Sure, that sounds reasonable.