Skip to content

Commit

Permalink
Release 2.0.0-rc1 (#221)
Browse files Browse the repository at this point in the history
* Release 2.0.0-rc1

* Remove .NET 8.0 setup preview flag

* Update version.txt

Co-authored-by: Caleb Lloyd <[email protected]>

* Update src/NATS.Net/NATS.Net.csproj

Co-authored-by: Caleb Lloyd <[email protected]>

---------

Co-authored-by: Caleb Lloyd <[email protected]>
  • Loading branch information
mtmk and caleblloyd authored Nov 17, 2023
1 parent f7057a2 commit dc6bc00
Show file tree
Hide file tree
Showing 11 changed files with 56 additions and 29 deletions.
1 change: 0 additions & 1 deletion .github/workflows/perf.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 0 additions & 2 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -93,7 +92,6 @@ jobs:
uses: actions/setup-dotnet@v3
with:
dotnet-version: '8.x'
dotnet-quality: 'preview'

- name: Get nats-server
shell: bash
Expand Down
7 changes: 7 additions & 0 deletions NATS.Client.sln
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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}
Expand Down
23 changes: 9 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,27 @@
# 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

Check out the [documentation](https://nats-io.github.io/nats.net.v2/) for guides and examples.

**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)
Expand All @@ -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)
2 changes: 1 addition & 1 deletion docs/api/index.md
Original file line number Diff line number Diff line change
@@ -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/).
6 changes: 3 additions & 3 deletions docs/documentation/intro.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/documentation/update-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/):

```
Expand Down
14 changes: 9 additions & 5 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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
Expand Down
25 changes: 25 additions & 0 deletions src/NATS.Net/NATS.Net.csproj
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<TargetFramework>net6.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
<AllowUnsafeBlocks>true</AllowUnsafeBlocks>
<IsTrimmable>true</IsTrimmable>

<!-- NuGet Packaging -->
<PackageTags>pubsub;messaging</PackageTags>
<Description>NATS client for modern .NET.</Description>
<IsPackable>true</IsPackable>
</PropertyGroup>

<ItemGroup>
<ProjectReference Include="..\NATS.Client.Core\NATS.Client.Core.csproj" />
<ProjectReference Include="..\NATS.Client.Hosting\NATS.Client.Hosting.csproj" />
<ProjectReference Include="..\NATS.Client.JetStream\NATS.Client.JetStream.csproj" />
<ProjectReference Include="..\NATS.Client.KeyValueStore\NATS.Client.KeyValueStore.csproj" />
<ProjectReference Include="..\NATS.Client.ObjectStore\NATS.Client.ObjectStore.csproj" />
<ProjectReference Include="..\NATS.Client.Services\NATS.Client.Services.csproj" />
</ItemGroup>

</Project>
2 changes: 1 addition & 1 deletion version.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
2.0.0-beta.3
2.0.0-rc.1

0 comments on commit dc6bc00

Please sign in to comment.