README Default workflow currently configured

gaelcolas / Sampler

Module template with build pipeline and examples, including DSC elements.

MIT License

171 stars 42 forks source link

README Default workflow currently configured #461

Open PFierlafijn opened 10 months ago

PFierlafijn commented 10 months ago

I'm new to Sampler, so I'm reading the README.md. I spotted, what I believe, is a typo. But is confuses me what is mend.

When I look at the first phrase in default workflow currently configured it is sugested to edit de build.psd1 as seen in de bootstrap section. The bootstrap section doesn't mention build.psd1, nor does the module contains a build.psd1 I think.

Should this not be build.ps1 or build.yaml?

johlju commented 10 months ago

The build configuration file can be either build.psd1, build.yaml, or build.json (and possibly build.jsonc). So the README should actually be change to say that.

https://github.com/gaelcolas/Sampler/blob/5d47846d80c420f79b13290beebee967b1179357/build.ps1#L375-L377

I have not personally tested that anything other than a yaml file, so not sure anything else works (but a bug in that case). 🙂