Skip to content

Known issues and Workarounds

Steven Maillet edited this page Jun 25, 2025 · 2 revisions
  1. Apparent circular dependency
    Probably the first and most significant issue that anyone maintaining this repo needs to deal with is the inherent circular dependency for the build task assembly itself. It cannot reference itself to provide automated versioning for itself. The means to break this cycle is to manually replicate the generated versioning values using some alternative means (In this case PowerShell scripts). They generate the required information into a GeneratedVersion.props file that is then imported into each project via the Directory.build.props file. This is then VALITED against what the task assembly would have created by the unit testing to ensure the manual process matches what the tasks themselves would have produced.
  2. StyleCop in Perpetual Preview mode The SytleCop analyzers are used to flag a large number of issues and ensure the repo stays relatively consistent in style. However, due to how that is maintained and various political choices made related to that, the analyzer itself is and has been in a perpetual preview mode. This is a hotly contested issue where some go the extreme of throwing away use of this analyzer as a result. This seems a tad on the excessive side of things as losing support for automated style analysis is a HUGE loss. This repository just accepts the reality of that and uses the preview build. Sadly, it does mean that some of the noisy/controversial rules are disabled outright, or the less noisy ones are suppressed in the code (with attributes or isolated to very small areas with #pragma)
Clone this wiki locally