CodeCompass.Core
0.13.0
dotnet add package CodeCompass.Core --version 0.13.0
NuGet\Install-Package CodeCompass.Core -Version 0.13.0
<PackageReference Include="CodeCompass.Core" Version="0.13.0" />
<PackageVersion Include="CodeCompass.Core" Version="0.13.0" />
<PackageReference Include="CodeCompass.Core" />
paket add CodeCompass.Core --version 0.13.0
#r "nuget: CodeCompass.Core, 0.13.0"
#:package CodeCompass.Core@0.13.0
#addin nuget:?package=CodeCompass.Core&version=0.13.0
#tool nuget:?package=CodeCompass.Core&version=0.13.0
CodeCompass.Core
The shared foundation of the CodeCompass tool family: one .NET library that owns the primitives every capability needs, so that nothing is implemented twice.
Core ships as a NuGet package usable from any .NET consumer. The capabilities built on it
(CodeCompass.Release today) are thin PowerShell modules on PSGallery that bundle the
compiled library.
dotnet add package CodeCompass.Core
The published versions are the tags of this repository. The decision behind each release is in the decision log.
What is in it
| Area | Namespace | What it owns |
|---|---|---|
| Versioning | Versioning, VersionService, Git |
Semantic version parse, compare, bump and render. A repository's version is its latest version tag, and the manifests that repeat it are found, compared and written |
| Releasing | Releases |
Is the repository ready to release, as CheckResult rows. The release plan from a part to increment or a version. The changelog heading and the manifests written from it |
| Technology providers | Providers, Repositories |
The provider contract (ITechnologyProvider), detection, and the registry. PowerShell and .NET providers |
| Workflow generation | Workflows |
CI, release, dependency-check and freshness workflows rendered from per-provider templates. The templates are embedded in this library |
| Workflow capability contract | Workflows.WorkflowContract |
What every provider's workflows must be able to do, checked by a conformance test, with explicit exemptions |
| Managed files | Files |
The manifest of what CodeCompass wrote into a repository, with hashes: write, update without overwriting an edit, adopt, assess |
| Configuration | Configuration, Serialization |
The typed model of .codecompass/config.yml. YAML handling is confined to Serialization, enforced by an architecture test |
| Results | Results |
CheckResult, the family's answer type |
A technology is added by implementing ITechnologyProvider, never by editing a switch, and
only when a repository needs it.
Example
using CodeCompass.Core;
using CodeCompass.Core.Versioning;
using CodeCompass.Core.Workflows;
var versions = new VersionService();
var current = versions.GetVersion(repoRoot).Version;
var next = versions.GetNextVersion(repoRoot, VersionPart.Minor).Next;
var workflows = new WorkflowService();
var report = workflows.Assess(repoRoot, managedBy: "CodeCompass.Release");
Where the truth is
| Question | Source |
|---|---|
| Why is it built this way | .specifications/codecompass-architecture.md: the architecture and the decision log (D-001 onward) |
| Where is the family going | .specifications/codecompass-roadmap.md |
| What is the contract | .specifications/codecompass-core-spec.md, and a slice spec beside it for each capability added since |
| Where does the work stand | .project/project-tracker.md |
Building and testing
dotnet build -c Release
dotnet test -c Release
Unit tests, an architecture test, and conformance tests for the workflow contract and the
templates. Some tests make throwaway git repositories, and the release gate's tests run its script
with pwsh, so both need to be on the PATH. CI runs them on Windows and Linux.
A tag v* publishes to NuGet with the version taken from the tag, after the release gate has
checked the tag. What changed in each version is in CHANGELOG.md.
Principle
Decisions live in enforced code, not prose. Core is the single implementation of the family's primitives. A statement in this repository that nothing checks is a statement that will drift.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
| .NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
| .NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
| .NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
| MonoAndroid | monoandroid was computed. |
| MonoMac | monomac was computed. |
| MonoTouch | monotouch was computed. |
| Tizen | tizen40 was computed. tizen60 was computed. |
| Xamarin.iOS | xamarinios was computed. |
| Xamarin.Mac | xamarinmac was computed. |
| Xamarin.TVOS | xamarintvos was computed. |
| Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- YamlDotNet (>= 13.7.1)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
| Version | Downloads | Last Updated |
|---|---|---|
| 0.13.0 | 61 | 11/18/2026 |
| 0.12.0 | 84 | 11/17/2026 |
| 0.11.1 | 96 | 11/17/2026 |
| 0.11.0 | 96 | 11/16/2026 |
| 0.10.1 | 107 | 11/13/2026 |
| 0.10.0 | 166 | 7/7/2026 |
| 0.9.1 | 135 | 7/4/2026 |
| 0.9.0 | 132 | 7/4/2026 |
| 0.8.0 | 135 | 7/3/2026 |
| 0.7.0 | 135 | 7/2/2026 |
| 0.6.0 | 133 | 7/2/2026 |
| 0.5.0 | 133 | 7/2/2026 |
| 0.4.0 | 131 | 7/2/2026 |
| 0.3.0 | 131 | 7/2/2026 |
| 0.2.0 | 135 | 7/2/2026 |
| 0.1.0 | 130 | 7/2/2026 |