website icon indicating copy to clipboard operation
website copied to clipboard

The docs need to detail how Cake uses the tools folder.

Open gep13 opened this issue 7 years ago • 2 comments

@RaringCoder commented on Tue Jan 02 2018

A user from the gitter channel highlighted an issue whereby they performed an update to the Cake version. This causes the bootstrapper to flush the tools folder and re-fetch all packages. Unfortunately, there were things in the tools folder (that existed prior to Cake being used) that weren't under control of Cake scripts and were deleted.

This exclusivity over the tools folder (being a sibling of the build.ps1 script), isn't necessarily a problem, but in the very least it needs to be made clear that the current implementation of the bootstrapping script assumes exclusivity.

Personally I feel this would be best placed in the Getting Started guide, where the tools directory is listed.

Further to this, better ways to assert tool versions could be investigated to make the "delete all" approach more granular. It may also be beneficial to make the tools directory more obviously configurable.


@gep13 commented on Wed Jan 03 2018

@RaringCoder this is probably best moved to the website repository, as that is where most of the top level documentation is located.


@RaringCoder commented on Wed Jan 03 2018

@gep13 Can you migrate tickets or is it a close and recreate job?

gep13 avatar Jan 03 '18 13:01 gep13

@RaringCoder done :-)

gep13 avatar Jan 03 '18 13:01 gep13

There should be a warning annotation in the https://cakebuild.net/docs/running-builds/runners/cake-runner-for-dotnet-framework#bootstrapping-for-cake-runner-for.net-framework chapter

pascalberger avatar Oct 12 '20 23:10 pascalberger