Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .config/dotnet-tools.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"isRoot": true,
"tools": {
"powershell": {
"version": "7.4.6",
"version": "7.5.0",
"commands": [
"pwsh"
],
Expand Down
4 changes: 4 additions & 0 deletions .github/renovate.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@
"matchDepNames": ["dotnet-sdk", "mcr.microsoft.com/dotnet/sdk"],
"groupName": "Dockerfile and global.json updates"
},
{
"matchPackageNames": ["Microsoft.VisualStudio.Internal.MicroBuild*"],
"groupName": "microbuild"
},
{
"matchPackageNames": ["System.Collections.Immutable", "System.Text.Json", "System.Threading.Tasks.Dataflow", "System.Diagnostics.DiagnosticSource"],
"allowedVersions": "<9.0",
Expand Down
6 changes: 5 additions & 1 deletion .github/workflows/docs_validate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,16 @@ on:

jobs:
build:
name: 📚 docfx
name: 📚 Doc validation
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0 # avoid shallow clone so nbgv can do its work.
- name: 🔗 Markup Link Checker (mlc)
uses: becheran/[email protected]
with:
args: --do-not-warn-for-redirect-to https://learn.microsoft.com*,https://dev.azure.com/*,https://app.codecov.io/*,https://msrc.microsoft.com/*,https://www.microsoft.com/en-us/msrc* -p docfx -i https://aka.ms/onboardsupport,https://aka.ms/spot,https://www.microsoft.com/msrc/cvd,https://www.microsoft.com/msrc
- name: ⚙ Install prerequisites
run: |
./init.ps1 -UpgradePrerequisites
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/libtemplate-update.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ jobs:

# Pushing commits that add or change files under .github/workflows will cause our workflow to fail.
# But it usually isn't necessary because the target branch already has (or doesn't have) these changes.
# So if the merged doesn't bring in any changes to these files, try the merge locally and push that
# So if the merge doesn't bring in any changes to these files, try the merge locally and push that
# to keep github happy.
if ((git rev-list FETCH_HEAD ^HEAD --count -- .github/workflows) -eq 0) {
# Indeed there are no changes in that area. So merge locally to try to appease GitHub.
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ You should install the version specified in `global.json` or a later version wit
the same major.minor.Bxx "hundreds" band.
For example if 2.2.300 is specified, you may install 2.2.300, 2.2.301, or 2.2.310
while the 2.2.400 version would not be considered compatible by .NET SDK.
See [.NET Core Versioning](https://docs.microsoft.com/dotnet/core/versions/) for more information.
See [.NET Core Versioning](https://learn.microsoft.com/dotnet/core/versions/) for more information.

## Package restore

Expand All @@ -47,7 +47,7 @@ Building, testing, and packing this repository can be done by using the standard
## 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://dotnet.github.io/Nerdbank.GitVersioning/docs/nbgv-cli.html).

Push the tag.

Expand Down
6 changes: 3 additions & 3 deletions doc/oob_streams.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ JSON-RPC is great for invoking methods and passing regular data types as argumen
When you want to pass binary data or stream a great deal of text without encoding as a very large JSON message,
StreamJsonRpc gives you an option to pass `Stream`, `IDuplexPipe`, `PipeReader` or `PipeWriter` as an argument or as a return type for an RPC method.

The content of the `Stream` or `IDuplexPipe` is transmitted out of band of the JSON-RPC channel so that no extra encoding is required. This out of band channel is provisioned from a [`MultiplexingStream`](https://github.com/AArnott/Nerdbank.Streams/blob/master/doc/MultiplexingStream.md) that can optionally be provided to the `JsonMessageFormatter` (or other formatters that support this feature). The `JsonRpc` connection itself is expected to be one of the channels in this `MultiplexingStream`.
The content of the `Stream` or `IDuplexPipe` is transmitted out of band of the JSON-RPC channel so that no extra encoding is required. This out of band channel is provisioned from a [`MultiplexingStream`](https://dotnet.github.io/Nerdbank.Streams/docs/MultiplexingStream.html) that can optionally be provided to the `JsonMessageFormatter` (or other formatters that support this feature). The `JsonRpc` connection itself is expected to be one of the channels in this `MultiplexingStream`.
This can be configured like this (creation of the `MultiplexingStream` is out of scope of this topic):

```cs
Expand Down Expand Up @@ -56,7 +56,7 @@ public Stream GetFile(string path) {
Passing out of band streams/pipes along JSON-RPC messages requires care be taken to avoid leaving
abandoned `MultiplexingStream` channels active and consuming resources in corner cases.
To facilitate this, the following rules apply:

1. The client can only send an `IDuplexPipe` in a request (that expects a response).
Notifications would not provide the client with feedback that the server dropped it, leaking resources.
1. The client will immediately terminate the `IDuplexPipe` if the server returns ANY error in response to the request, since the server may not be aware of the `IDuplexPipe`.
Expand Down Expand Up @@ -98,7 +98,7 @@ If you need to know when the `Stream` has received all data you have two options
This indicates the remote party is done transmitting.
1. When the `Stream` is an argument you are passing to the RPC server, and you are *not* reading the stream directly
(e.g. it's a `FileStream` and the remote party is writing the file for you),
you can first wrap the `Stream` in a [`MonitoringStream`](https://github.com/AArnott/Nerdbank.Streams/blob/master/doc/MonitoringStream.md)
you can first wrap the `Stream` in a [`MonitoringStream`](https://dotnet.github.io/Nerdbank.Streams/docs/MonitoringStream.html)
and pass that wrapper in as your `Stream` argument.
This gives you an option to observe when the `Stream` is disposed. For example:

Expand Down
2 changes: 1 addition & 1 deletion doc/tracecontext.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ For proper activity recording in trace logs, be sure to set the `SourceLevels.Ac
### Creating and reviewing trace logs

Reviewing trace files is much easier, particularly when reviewing many files that may span processes and/or machines, when using a tool such as [Service Trace Viewer][ServiceTraceViewer].
This viewer reads trace files written with the [`XmlWriterTraceListener`](XmlWriterTraceListener).
This viewer reads trace files written with the [`XmlWriterTraceListener`][XmlWriterTraceListener].
Add an instance of this class to your `TraceSource.Listeners` collection for the best trace log viewing experience.
This can be used in combination with other unstructured `TraceListener`-derived classes if desired.

Expand Down
2 changes: 1 addition & 1 deletion tools/Get-NuGetTool.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
#>
Param(
[Parameter()]
[string]$NuGetVersion='6.4.0'
[string]$NuGetVersion='6.12.2'
)

$toolsPath = & "$PSScriptRoot\Get-TempToolsPath.ps1"
Expand Down
Loading