From ba66bd050ac68392e279e8d89117b1bc4e801a8d Mon Sep 17 00:00:00 2001 From: Emmanuel Ferdman Date: Tue, 31 Dec 2024 09:46:20 -0800 Subject: [PATCH 1/2] Update `nbgv` CLI reference Signed-off-by: Emmanuel Ferdman --- CONTRIBUTING.md | 2 +- docfx/docs/public-vs-stable.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 12206180..edfad9ca 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -48,7 +48,7 @@ The Visual Studio 2019 Test Explorer will list and execute all tests. ## Releases Use `nbgv tag` to create a tag for a particular commit that you mean to release. -[Learn more about `nbgv` and its `tag` and `prepare-release` commands](https://github.com/dotnet/Nerdbank.GitVersioning/blob/main/doc/nbgv-cli.md). +[Learn more about `nbgv` and its `tag` and `prepare-release` commands](https://github.com/dotnet/Nerdbank.GitVersioning/blob/main/docfx/docs/nbgv-cli.md). Push the tag. diff --git a/docfx/docs/public-vs-stable.md b/docfx/docs/public-vs-stable.md index d1f180cf..cfff2ae3 100644 --- a/docfx/docs/public-vs-stable.md +++ b/docfx/docs/public-vs-stable.md @@ -124,4 +124,4 @@ Consider that main builds a 1.2 version, and has a version height of 10. So its Or, if the topic branch *has* committed and moved onto 1.2.11, that could still collide because `main` may have moved on as well, using that same version. But since the topic branch always adds `-gc0ffee` hash suffixes to the package version, it won't conflict. Also: you don't want a topic branch to be seen as newer and better than what's in the main branch unless the user is explicitly opting into unstable behavior, so the `-gc0ffee` suffix is useful because it forces the package to be seen as "unstable". Once it merges with `main`, it will drop its `-gc0ffee` suffix, but will retain any other `-prerelease` tag specified in the version.json file. -[nbgv_prepare-release]: https://github.com/dotnet/Nerdbank.GitVersioning/blob/master/doc/nbgv-cli.md#preparing-a-release +[nbgv_prepare-release]: https://github.com/dotnet/Nerdbank.GitVersioning/blob/master/docfx/docs/nbgv-cli.md#preparing-a-release From 575f34a6cb94abed251e8d2a192708d3e1e8a3bf Mon Sep 17 00:00:00 2001 From: Andrew Arnott Date: Tue, 31 Dec 2024 15:01:08 -0700 Subject: [PATCH 2/2] Update links to the GitHub Pages location which renders better --- CONTRIBUTING.md | 2 +- docfx/docs/public-vs-stable.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index edfad9ca..357e9c96 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -48,7 +48,7 @@ The Visual Studio 2019 Test Explorer will list and execute all tests. ## Releases Use `nbgv tag` to create a tag for a particular commit that you mean to release. -[Learn more about `nbgv` and its `tag` and `prepare-release` commands](https://github.com/dotnet/Nerdbank.GitVersioning/blob/main/docfx/docs/nbgv-cli.md). +[Learn more about `nbgv` and its `tag` and `prepare-release` commands](https://dotnet.github.io/Nerdbank.GitVersioning/docs/nbgv-cli.html). Push the tag. diff --git a/docfx/docs/public-vs-stable.md b/docfx/docs/public-vs-stable.md index cfff2ae3..3f28c15e 100644 --- a/docfx/docs/public-vs-stable.md +++ b/docfx/docs/public-vs-stable.md @@ -124,4 +124,4 @@ Consider that main builds a 1.2 version, and has a version height of 10. So its Or, if the topic branch *has* committed and moved onto 1.2.11, that could still collide because `main` may have moved on as well, using that same version. But since the topic branch always adds `-gc0ffee` hash suffixes to the package version, it won't conflict. Also: you don't want a topic branch to be seen as newer and better than what's in the main branch unless the user is explicitly opting into unstable behavior, so the `-gc0ffee` suffix is useful because it forces the package to be seen as "unstable". Once it merges with `main`, it will drop its `-gc0ffee` suffix, but will retain any other `-prerelease` tag specified in the version.json file. -[nbgv_prepare-release]: https://github.com/dotnet/Nerdbank.GitVersioning/blob/master/docfx/docs/nbgv-cli.md#preparing-a-release +[nbgv_prepare-release]: https://dotnet.github.io/Nerdbank.GitVersioning/docs/nbgv-cli.html#preparing-a-release