gaelcolas / Sampler

Module template with build pipeline and examples, including DSC elements.
MIT License
171 stars 42 forks source link

Update the module.tests.ps1 template #466

Closed Sidoran closed 7 months ago

Sidoran commented 9 months ago

Pull Request

Pull Request (PR) description

Fixed

Task list


This change is Reviewable

codecov[bot] commented 9 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 81%. Comparing base (5c10447) to head (54a945c).

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/gaelcolas/Sampler/pull/466/graphs/tree.svg?width=650&height=150&src=pr&token=xHbQB1FHYN&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Gael)](https://app.codecov.io/gh/gaelcolas/Sampler/pull/466?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Gael) ```diff @@ Coverage Diff @@ ## main #466 +/- ## =================================== Coverage 81% 81% =================================== Files 44 44 Lines 2328 2328 =================================== Hits 1904 1904 Misses 424 424 ```
johlju commented 8 months ago

Also if there are a module project in the root of TestSampler, and there is a module project in a the subfolder SecondModule

This scenario might be difficult to determine without scanning each subfolder 🤔 So maybe for this case we just document that it is not recommended to have a module project in the root folder at the same time as having module projects in subfolders. 🤔

Sidoran commented 8 months ago

Hi @johlju, TY for paying attention to this issue. Modifying several modules simultaneously in one multi-module repo is not a good idea, but the code should support it. I changed the code, and from now each module folder will be checked separately.

About the second case (The repo with the module in root and the other module in a subfolder). It would be tough to divide which module file is related (to the root level or the module in a subfolder). I am inclined not to support the given type of multi-module repo to not deeper into a folder structure and all other items. I would happily update the documentation with the info that a given type of repo may generate false positive errors. Can you please point me to where I can add this info?

johlju commented 8 months ago

I would happily update the documentation with the info that a given type of repo may generate false positive errors. Can you please point me to where I can add this info?

Suggest adding a new section under https://github.com/gaelcolas/Sampler/blob/main/README.md#how-to-create-a-new-project

Sidoran commented 8 months ago

The Readme.md file has been updated with the multi-module repository information.