diff --git a/.github/workflows/perf.yml b/.github/workflows/perf.yml index 7aa320386..c23a2407e 100644 --- a/.github/workflows/perf.yml +++ b/.github/workflows/perf.yml @@ -48,7 +48,6 @@ jobs: uses: actions/setup-dotnet@v3 with: dotnet-version: '8.x' - dotnet-quality: 'preview' - name: Release Build run: dotnet build -c Release tests/NATS.Client.Perf/NATS.Client.Perf.csproj diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index fccc3a489..c40cd799b 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -40,7 +40,6 @@ jobs: uses: actions/setup-dotnet@v3 with: dotnet-version: '8.x' - dotnet-quality: 'preview' - if: ${{ fromJSON(steps.tag.outputs.create) }} name: Pack diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 94aaba1af..8c9e682b0 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -40,7 +40,6 @@ jobs: uses: actions/setup-dotnet@v3 with: dotnet-version: '8.x' - dotnet-quality: 'preview' - name: Build run: dotnet build -c Debug @@ -93,7 +92,6 @@ jobs: uses: actions/setup-dotnet@v3 with: dotnet-version: '8.x' - dotnet-quality: 'preview' - name: Get nats-server shell: bash diff --git a/NATS.Client.sln b/NATS.Client.sln index 5deda76bb..ee7313b6d 100644 --- a/NATS.Client.sln +++ b/NATS.Client.sln @@ -99,6 +99,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "NATS.Client.Serializers.Jso EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "NATS.Client.Testing.Failground", "tests\NATS.Client.Testing.Failground\NATS.Client.Testing.Failground.csproj", "{C9170DB0-B4BC-4CFC-B3BB-34ABF3563E11}" EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "NATS.Net", "src\NATS.Net\NATS.Net.csproj", "{6A7B9B9F-BFA4-4A6D-9006-0AAF597FC6DD}" +EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Any CPU = Debug|Any CPU @@ -261,6 +263,10 @@ Global {C9170DB0-B4BC-4CFC-B3BB-34ABF3563E11}.Debug|Any CPU.Build.0 = Debug|Any CPU {C9170DB0-B4BC-4CFC-B3BB-34ABF3563E11}.Release|Any CPU.ActiveCfg = Release|Any CPU {C9170DB0-B4BC-4CFC-B3BB-34ABF3563E11}.Release|Any CPU.Build.0 = Release|Any CPU + {6A7B9B9F-BFA4-4A6D-9006-0AAF597FC6DD}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {6A7B9B9F-BFA4-4A6D-9006-0AAF597FC6DD}.Debug|Any CPU.Build.0 = Debug|Any CPU + {6A7B9B9F-BFA4-4A6D-9006-0AAF597FC6DD}.Release|Any CPU.ActiveCfg = Release|Any CPU + {6A7B9B9F-BFA4-4A6D-9006-0AAF597FC6DD}.Release|Any CPU.Build.0 = Release|Any CPU EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE @@ -306,6 +312,7 @@ Global {9FCD9377-FE5F-4D94-BDCF-54427DB6487D} = {95A69671-16CA-4133-981C-CC381B7AAA30} {5B4B30A5-941B-44F9-98C6-06F0BB2242AB} = {4827B3EC-73D8-436D-AE2A-5E29AC95FD0C} {C9170DB0-B4BC-4CFC-B3BB-34ABF3563E11} = {C526E8AB-739A-48D7-8FC4-048978C9B650} + {6A7B9B9F-BFA4-4A6D-9006-0AAF597FC6DD} = {4827B3EC-73D8-436D-AE2A-5E29AC95FD0C} EndGlobalSection GlobalSection(ExtensibilityGlobals) = postSolution SolutionGuid = {8CBB7278-D093-448E-B3DE-B5991209A1AA} diff --git a/README.md b/README.md index a1e3070ec..bfd7b232c 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,12 @@ -# NATS .NET V2 +# NATS.Net -NATS.NET V2 is a [NATS](https://nats.io) client for the modern [.NET](https://dot.net/). +NATS.Net is a [NATS](https://nats.io) client for the modern [.NET](https://dot.net/). -## Preview (Beta) +## Release Candidate -The NATS.NET V2 client is in *beta* phase and recommended for testing and feedback. -Although codebase is still under development, APIs are relatively stable and we are -looking for feedback on usability and features. +The NATS.Net is ready to *Go Live*! -You can provide feedback: - -* on [slack.nats.io dotnet channel](https://natsio.slack.com/channels/dotnet) -* or use GitHub discussions, issues and PRs - -Thank you to our contributors so far. We feel we are growing slowly as a community and we appreciate your help -supporting and developing NATS .NET V2 project. +Big thank you to our contributors. ## Documentation @@ -22,13 +14,14 @@ Check out the [documentation](https://nats-io.github.io/nats.net.v2/) for guides **Additionally check out [NATS by example](https://natsbyexample.com) - An evolving collection of runnable, cross-client reference examples for NATS.** -## NATS.NET V2 Goals +## NATS.Net Goals - Only support Async I/O (async/await) - Target latest .NET LTS Release (currently .NET 6.0, soon .NET 8.0) ## Packages +- **NATS.Net**: Meta package that includes all other packages (except serialization) - **NATS.Client.Core**: [Core NATS](https://docs.nats.io/nats-concepts/core-nats) - **NATS.Client.Hosting**: extension to configure DI container - **NATS.Client.JetStream**: [JetStream](https://docs.nats.io/nats-concepts/jetstream) @@ -42,6 +35,8 @@ Check out the [documentation](https://nats-io.github.io/nats.net.v2/) for guides - Run `dotnet format` at root directory of project in order to clear warnings that can be auto-formatted - Run `dotnet build` at root directory and make sure there are no errors or warnings +Find us on [slack.nats.io dotnet channel](https://natsio.slack.com/channels/dotnet) + ## Attribution This library is based on the excellent work in [Cysharp/AlterNats](https://github.com/Cysharp/AlterNats) diff --git a/docs/api/index.md b/docs/api/index.md index ab2633602..943e97776 100644 --- a/docs/api/index.md +++ b/docs/api/index.md @@ -1,4 +1,4 @@ # API Documentation -You can browse the latest NATS.NET V2 API Documentation here. +You can browse the latest NATS.Net API Documentation here. API Documentation is auto-generated using [DocFX](https://dotnet.github.io/docfx/). diff --git a/docs/documentation/intro.md b/docs/documentation/intro.md index c15af3763..5dea6831b 100644 --- a/docs/documentation/intro.md +++ b/docs/documentation/intro.md @@ -1,10 +1,10 @@ -# NATS.NET V2 Client +# NATS.Net -NATS.NET V2 Client is a .NET client for the Open Source [Connective Technology for Adaptive Edge & Distributed Systems - NATS](https://nats.io/)! +NATS.Net is a .NET client for the Open Source [Connective Technology for Adaptive Edge & Distributed Systems - NATS](https://nats.io/)! It's build on top of the modern .NET platform, taking advantage of all the high performance features and asynchronous programming model. -NATS.NET V2 Client, just like NATS, is Open Source as is this documentation. +NATS.Net, just like NATS, is Open Source as is this documentation. Please [let us know](https://natsio.slack.com/channels/dotnet) if you have updates and/or suggestions for these docs. You can also create a Pull Request using the Edit on GitHub link on each page. diff --git a/docs/documentation/update-docs.md b/docs/documentation/update-docs.md index 7f33ae563..c8a887865 100644 --- a/docs/documentation/update-docs.md +++ b/docs/documentation/update-docs.md @@ -5,7 +5,7 @@ view locally and submit a Pull Request to be included in this documentation site ## Runnig DocFX locally -Clone the NATS.NET V2 repository, then run `docfx` local server to view this documentation site. +Clone the NATS.Net ([nats-io/nats.net.v2](https://github.com/nats-io/nats.net.v2)) repository, then run `docfx` local server to view this documentation site. You mush have [DocFX installed](https://dotnet.github.io/docfx/): ``` diff --git a/docs/index.md b/docs/index.md index 84c6948b4..59fb6b59f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,10 +1,12 @@ -# NATS.NET V2 +# NATS.Net -NATS.NET V2 is a [NATS](https://nats.io) client for the modern [.NET](https://dot.net/). +NATS.Net is a [NATS](https://nats.io) client for the modern [.NET](https://dot.net/). -## Preview (Beta) +## Release Candidate -The NATS.NET V2 client is in *beta* phase and recommended for testing and feedback. +The NATS.Net is ready to *Go Live*! + +Big thank you to our contributors. ## Roadmap @@ -16,7 +18,9 @@ The NATS.NET V2 client is in *beta* phase and recommended for testing and feedba - [x] .NET 8.0 support (Native AOT) - [x] Implementation of missing major features (e.g. JetStream ordered consumers) - [x] Beta phase -- [ ] Testing and bug fixing +- [x] Testing and bug fixing +- [x] Release Candidate +- [ ] Documentation and examples updates - [ ] General Availability ## What's Next diff --git a/src/NATS.Net/NATS.Net.csproj b/src/NATS.Net/NATS.Net.csproj new file mode 100644 index 000000000..5195f793c --- /dev/null +++ b/src/NATS.Net/NATS.Net.csproj @@ -0,0 +1,25 @@ + + + + net6.0 + enable + enable + true + true + + + pubsub;messaging + NATS client for modern .NET. + true + + + + + + + + + + + + diff --git a/version.txt b/version.txt index 96cabdf34..97041a78c 100644 --- a/version.txt +++ b/version.txt @@ -1 +1 @@ -2.0.0-beta.3 +2.0.0-rc.1