Document global.json caveats

Phault · Feb 6, 2024 · c9164db · c9164db
1 parent ffec535
commit c9164db
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,16 @@
 # Changelog
 
+## 0.1.0
+
+#### global.json detection
+
+The plugin will now try to respect any [global.json](https://learn.microsoft.com/en-us/dotnet/core/tools/global-json) it finds,
+but it is done in a best effort manner.
+
+proto will always prefer the highest version you allow it, so the `major`, `minor`, `feature` and `patch` options for the `rollForward` field, will instead act like `latestMajor`, `latestMinor`, `latestFeature` and `latestPatch` respectively.
+
+The `allowPrerelease` field is simply ignored. Due to limitations in proto, or rather it's supporting semver library, this would be troublesome to implement in a faithful way. You may still specify a prerelease in the `version` field however, but how this works together with `rollForward` hasn't been tested.
+
 ## 0.0.1
 
 #### 🎉 Release

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "dotnet_plugin"
-version = "0.0.1"
+version = "0.1.0"
 edition = "2021"
 license = "MIT"
 publish = false

diff --git a/README.md b/README.md
@@ -31,6 +31,17 @@ proto install dotnet lts
 proto install dotnet 8.0.101
 ```
 
+## Caveats
+
+### global.json detection
+
+The plugin will try to respect any [global.json](https://learn.microsoft.com/en-us/dotnet/core/tools/global-json) it finds,
+but it is done in a best effort manner.
+
+proto will always prefer the highest version you allow it, so the `major`, `minor`, `feature` and `patch` options for the `rollForward` field, will instead act like `latestMajor`, `latestMinor`, `latestFeature` and `latestPatch` respectively.
+
+The `allowPrerelease` field is simply ignored. Due to limitations in proto, or rather it's supporting semver library, this would be troublesome to implement in a faithful way. You may still specify a prerelease in the `version` field however, but how this works together with `rollForward` hasn't been tested.
+
 ## Configuration
 
 .NET plugin does not support configuration.