tmaestrini / easyGovernance

governance and validation for configuration baselines in M365 – made as easy as possible
MIT License
13 stars 4 forks source link

`settings_template.yml` vs. `baselines` files #34

Closed sympmarc closed 3 months ago

sympmarc commented 3 months ago

The baselines listed in settings_template.yml don't match the filenames in the baselines folder. I still think getting up and running is a bit confusing - and I'm a good guinea pig for that.

Is it the intention that if the filenames in the baselines folder change, then they should also change in settings_template.yml? The ps1 files like src\Private\Validation\Test-M365.1-1.1.ps1 also seem to have to match the baselines filenames. It feels a bit brittle to me.

tmaestrini commented 3 months ago

@sympmarc Thanks for your contribution! The filenames in the baselines folder don't match the references in the tenant settings file (settings_template.yml). As you've described, this could lead to confusion.

For now, there are two options to reference a baseline from the tenant settings file:

  1. By referencing its filename (aka the "name" of the file without .yml suffix); e.g. M365.IAM.1-2.1
  2. By referencing its id which is contained in the baseline; e.g. M365.1-2.1

It doesn't matter which option you choose.

But to make it clearer from an end user perspective, I think we should add this to the documentation here (directly on the develop branch): https://github.com/tmaestrini/easyGovernance#tenant-settings-file

tmaestrini commented 3 months ago

@sympmarc My bad – you were right: the reference must match filename of the .yml file in the baselines folder (or wherever you set the reference to). Therefore, I've changed the definitions in the settings_template.yml. Hoping that the confused guinea pig now is eating green grass again... 😃

sympmarc commented 3 months ago

🐹 GrassGIF