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: 2 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ jobs:
run: dotnet restore
- name: Build
run: dotnet build --no-restore
- name: Validate package
run: dotnet pack src/PostgreSignalR.csproj --no-build -c Debug
- name: Test
run: dotnet test --project tests/PostgreSignalR.IntegrationTests/PostgreSignalR.IntegrationTests.csproj -f ${{ matrix.tfm }} --no-build --output Detailed --hangdump --hangdump-timeout 2m --hangdump-type Mini --stop-on-fail on
timeout-minutes: 10
Expand Down
26 changes: 11 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@

# PostgreSignalR

<a href="https://www.nuget.org/packages/PostgreSignalR"><img alt="NuGet Version" src="https://img.shields.io/nuget/vpre/postgresignalr?style=for-the-badge&logo=nuget&label=%20&labelColor=gray"></a>
<a href="https://www.nuget.org/packages/PostgreSignalR"><img alt="NuGet Version" src="https://img.shields.io/nuget/v/postgresignalr?style=for-the-badge&logo=nuget&label=%20&labelColor=gray"></a>
<a href="https://github.com/IanWold/PostgreSignalR/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22good%20first%20issue%22"><img alt="GitHub Issues or Pull Requests by label" src="https://img.shields.io/github/issues/ianwold/postgresignalr/good%20first%20issue?style=for-the-badge&label=Good%20First%20Issues"></a>


A **non-opinionated** and easily **configurable** PostgreSQL backplane for SignalR

_Currently in Release Candidate stage and happy for your feedback!_
_Production-ready and happy for your feedback!_

</div>

Expand Down Expand Up @@ -230,24 +230,20 @@ To stress again though - these results are with one particular configuration on

# Roadmap

This library is brand-new, so while it should support all SignalR features it hasn't been thoroughly tested and vetted for production use. The immediate next steps are aimed at making this production-ready:
PostgreSignalR is ready for production use: it supports all SignalR features, is covered by an integration test suite that runs against every supported .NET version, and is already running in production systems.

1. Automated tests to ensure the functionality of the library
2. Performance tests and benchmarks to optimize the code and find at-scale bugs
3. Writing one or several example applications utilizing all of the SignalR features
4. Adding additional configuration options to allow more flexibility in error handling
5. Observe in production or production-like scenarios
## Versioning

Right now the library has been released on Nuget in a release candidate version, which I mean to be an indication that this is a stable product and the API is unlikely to change. Testing has been successful, and the only blocker for the production release is finishing a suite of benchmarks to be able to provide reliable documentation about the functionality of the library on the edge.
PostgreSignalR follows [Semantic Versioning](https://semver.org/). The public API consists of the dependency injection extensions, the options classes (`PostgresBackplaneOptions` and `PayloadTableOptions`), and the payload strategy types (`IPayloadStrategy`, `EventPayloadStrategy`, and `TablePayloadStrategy`). Breaking changes to any of these will only be made in a new major version.

* Alpha: The viability of the product is being tested, there are known major bugs
* Beta: Testing has given confidence that this is a viable product and major bugs and performance issues have been resolved
* RC: Further changes to the interface are unlikely and testing has indicated that the product is stable
* Prod: The library is ready for use in production systems
PostgreSignalR targets every version of .NET that is [currently supported by Microsoft](https://dotnet.microsoft.com/en-us/platform/support/policy/dotnet-core). Support for new .NET versions is added in minor versions, and support for a .NET version is dropped in a new major version once Microsoft stops supporting it.

Alpha and beta versions will progress through `0.x.0-alpha` and `0.x.0-beta`, while the release candidates will start at `1.0.0-rc-x`. `1.0.0` will be the first production release.
## Next Steps

I'm liking at a relatively quick timeline through RC and prod, though I do only get so many hours to work on this. Contributions are welcome!
1. Finish the benchmark suite to provide reliable documentation about the performance of the library at the edge
2. Add configuration options to allow more flexibility in error handling

Contributions are welcome!

# Developing and Testing

Expand Down
20 changes: 10 additions & 10 deletions README_NUGET.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,20 +77,20 @@ For more advanced use cases, PostgreSignalR allows you to create a custom payloa

# Roadmap

This library is brand-new, so while it should support all SignalR features it hasn't been thoroughly tested and vetted for production use. The immediate next steps are aimed at making this production-ready:
PostgreSignalR is ready for production use: it supports all SignalR features, is covered by an integration test suite that runs against every supported .NET version, and is already running in production systems.

1. Automated tests to ensure the functionality of the library
2. Performance tests and benchmarks to optimize the code and find at-scale bugs
3. Writing one or several example applications utilizing all of the SignalR features
4. Adding additional configuration options to allow more flexibility in error handling
## Versioning

Right now the library has been released on Nuget in an alpha version, denoting that it is relatively untested _and_ the API may be subject to change. In this case, the "API" consists entirely of the dependency injection extensions and the `PostgresOptions` class. The beta, rc, and prod milestones will denote:
PostgreSignalR follows [Semantic Versioning](https://semver.org/). The public API consists of the dependency injection extensions, the options classes (`PostgresBackplaneOptions` and `PayloadTableOptions`), and the payload strategy types (`IPayloadStrategy`, `EventPayloadStrategy`, and `TablePayloadStrategy`). Breaking changes to any of these will only be made in a new major version.

* Beta: Testing has given confidence that this is a viable product and major bugs and performance issues have been resolved
* RC: Further changes to the interface are unlikely and testing has indicated that the product is stable
* Prod: The library is ready for use in production systems
PostgreSignalR targets every version of .NET that is [currently supported by Microsoft](https://dotnet.microsoft.com/en-us/platform/support/policy/dotnet-core). Support for new .NET versions is added in minor versions, and support for a .NET version is dropped in a new major version once Microsoft stops supporting it.

Alpha and beta versions will progress through `0.x.0-alpha` and `0.x.0-beta`, while the release candidates will start at `1.0.0-rc.x`. `1.0.0` will be the first production release.
## Next Steps

1. Finish the benchmark suite to provide reliable documentation about the performance of the library at the edge
2. Add configuration options to allow more flexibility in error handling

Contributions are welcome!

# Developing and Testing

Expand Down
12 changes: 12 additions & 0 deletions src/CompatibilitySuppressions.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- https://learn.microsoft.com/dotnet/fundamentals/package-validation/diagnostic-ids -->
<Suppressions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<Suppression>
<DiagnosticId>PKV006</DiagnosticId>
<Target>net8.0</Target>
</Suppression>
<Suppression>
<DiagnosticId>PKV006</DiagnosticId>
<Target>net9.0</Target>
</Suppression>
</Suppressions>
1 change: 1 addition & 0 deletions src/PostgreSignalR.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
<EmbedUntrackedSources>true</EmbedUntrackedSources>
<ContinuousIntegrationBuild>true</ContinuousIntegrationBuild>
<EnablePackageValidation>true</EnablePackageValidation>
<PackageValidationBaselineVersion>0.5.0-rc-1</PackageValidationBaselineVersion>

<PackageTags>SignalR;Postgres;PostgreSQL;Npgsql;ASP;ASPNET;ASPNETCORE</PackageTags>
<RepositoryUrl>https://github.com/IanWold/PostgreSignalR</RepositoryUrl>
Expand Down
Loading