diff --git a/CHANGELOG.md b/CHANGELOG.md index 7085117ec..fa4197225 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,9 +2,12 @@ ## Improvements: +* Add xUnit 3 support (#405, #538) +* Add READMEs and XML documentation to all NuGet packages (#844) + ## Bug fixes: -*Contributors of this release (in alphabetical order):* +*Contributors of this release (in alphabetical order):* @304NotModified, @chekkan # v3.3.3 - 2026-01-27 @@ -123,6 +126,7 @@ * Fix: Dry Run mode doesn't work properly if the project contains hooks that register & inject custom dependencies (#862) *Contributors of this release (in alphabetical order):* @chekkan, @Code-Grump, @DrEsteban, @gasparnagy, @konarx +>>>>>>> b9f0963d1222796b757ea5a28544cd24fd3f2110 # v3.0.3 - 2025-09-17 diff --git a/Plugins/Reqnroll.Assist.Dynamic/Reqnroll.Assist.Dynamic/Reqnroll.Assist.Dynamic.csproj b/Plugins/Reqnroll.Assist.Dynamic/Reqnroll.Assist.Dynamic/Reqnroll.Assist.Dynamic.csproj index c874ab373..aa590c416 100644 --- a/Plugins/Reqnroll.Assist.Dynamic/Reqnroll.Assist.Dynamic/Reqnroll.Assist.Dynamic.csproj +++ b/Plugins/Reqnroll.Assist.Dynamic/Reqnroll.Assist.Dynamic/Reqnroll.Assist.Dynamic.csproj @@ -7,6 +7,8 @@ true true + true + $(NoWarn);1591 $(ReqnrollKeyFile) diff --git a/Plugins/Reqnroll.Autofac.ReqnrollPlugin/README.md b/Plugins/Reqnroll.Autofac.ReqnrollPlugin/README.md new file mode 100644 index 000000000..c03d11ef0 --- /dev/null +++ b/Plugins/Reqnroll.Autofac.ReqnrollPlugin/README.md @@ -0,0 +1,13 @@ +Reqnroll.Autofac provides [Autofac](https://github.com/autofac/Autofac) dependency injection integration for Reqnroll. + +Plugin supports both registration of dependencies globally and per scenario + +## Documentation + +For more information about using dependency injection with Reqnroll, see [Autofac - Reqnroll documentation](https://docs.reqnroll.net/latest/integrations/autofac.html). + +## Support + +- [Reqnroll Documentation](https://docs.reqnroll.net/) +- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) +- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Plugins/Reqnroll.Autofac.ReqnrollPlugin/Reqnroll.Autofac.ReqnrollPlugin.csproj b/Plugins/Reqnroll.Autofac.ReqnrollPlugin/Reqnroll.Autofac.ReqnrollPlugin.csproj index b715e2846..0da226127 100644 --- a/Plugins/Reqnroll.Autofac.ReqnrollPlugin/Reqnroll.Autofac.ReqnrollPlugin.csproj +++ b/Plugins/Reqnroll.Autofac.ReqnrollPlugin/Reqnroll.Autofac.ReqnrollPlugin.csproj @@ -2,6 +2,8 @@ netstandard2.0 Reqnroll.Autofac + true + $(NoWarn);1591 true true diff --git a/Plugins/Reqnroll.CustomPlugin/README.md b/Plugins/Reqnroll.CustomPlugin/README.md new file mode 100644 index 000000000..7f440e70f --- /dev/null +++ b/Plugins/Reqnroll.CustomPlugin/README.md @@ -0,0 +1,13 @@ +Reqnroll.CustomPlugin provides the required dependencies for writing custom Reqnroll generator extensions. + +This package serves as a template and example for creating custom plugins that extend Reqnroll functionality. It demonstrates how to create custom generators, transformations, and other extensions. + +## Documentation + +For more information about creating custom generator plugins, see [Generator Plugins - Reqnroll documentation](https://docs.reqnroll.net/latest/extend/plugins.html#generator-plugins). + +## Support + +- [Reqnroll Documentation](https://docs.reqnroll.net/) +- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) +- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Plugins/Reqnroll.CustomPlugin/Reqnroll.CustomPlugin.csproj b/Plugins/Reqnroll.CustomPlugin/Reqnroll.CustomPlugin.csproj index 9bfa6c707..bc87ddf3c 100644 --- a/Plugins/Reqnroll.CustomPlugin/Reqnroll.CustomPlugin.csproj +++ b/Plugins/Reqnroll.CustomPlugin/Reqnroll.CustomPlugin.csproj @@ -5,6 +5,11 @@ true false + true + true + true + $(NoWarn);1591 + Reqnroll.CustomPlugin Package for writing custom generator extensions for Reqnroll. diff --git a/Plugins/Reqnroll.ExternalData/Reqnroll.ExternalData.ReqnrollPlugin/README.md b/Plugins/Reqnroll.ExternalData/Reqnroll.ExternalData.ReqnrollPlugin/README.md new file mode 100644 index 000000000..eacbf7842 --- /dev/null +++ b/Plugins/Reqnroll.ExternalData/Reqnroll.ExternalData.ReqnrollPlugin/README.md @@ -0,0 +1,15 @@ +Reqnroll.ExternalData provides external data loading capabilities for Reqnroll scenarios. + +The Reqnroll ExternalData plugin lets teams separate test data from test scenarios, and reuse examples across a large set of scenarios. This is particularly helpful when a common set of examples needs to be consistently verified in different scenarios. + +Supported Data Sources: CSV, JSON, and excel files + +## Documentation + +For more information about using external data with Reqnroll, see [External Data Plugin - Reqnroll documentation](https://docs.reqnroll.net/latest/integrations/externaldata.html). + +## Support + +- [Reqnroll Documentation](https://docs.reqnroll.net/) +- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) +- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Plugins/Reqnroll.ExternalData/Reqnroll.ExternalData.ReqnrollPlugin/Reqnroll.ExternalData.ReqnrollPlugin.csproj b/Plugins/Reqnroll.ExternalData/Reqnroll.ExternalData.ReqnrollPlugin/Reqnroll.ExternalData.ReqnrollPlugin.csproj index 7ab45e38a..7d7905481 100644 --- a/Plugins/Reqnroll.ExternalData/Reqnroll.ExternalData.ReqnrollPlugin/Reqnroll.ExternalData.ReqnrollPlugin.csproj +++ b/Plugins/Reqnroll.ExternalData/Reqnroll.ExternalData.ReqnrollPlugin/Reqnroll.ExternalData.ReqnrollPlugin.csproj @@ -6,6 +6,9 @@ Reqnroll.ExternalData + true + $(NoWarn);1591 + true Package to use external data in Gherkin scenarios reqnroll externaldata json diff --git a/Plugins/Reqnroll.MSTest.Generator.ReqnrollPlugin/README.md b/Plugins/Reqnroll.MSTest.Generator.ReqnrollPlugin/README.md new file mode 100644 index 000000000..04903ed79 --- /dev/null +++ b/Plugins/Reqnroll.MSTest.Generator.ReqnrollPlugin/README.md @@ -0,0 +1,13 @@ +Reqnroll.MSTest enables using Reqnroll with [MSTest v2 test framework](https://learn.microsoft.com/en-us/dotnet/core/testing/unit-testing-csharp-with-mstest). + +This package provides integration between Reqnroll and MSTest v2, allowing you to write BDD tests using Gherkin syntax that run with the MSTest test framework. + +## Documentation + +For more information about using Reqnroll with MSTest, visit the [MSTest - Reqnroll documentation](https://docs.reqnroll.net/latest/integrations/mstest.html). + +## Support + +- [Reqnroll Documentation](https://docs.reqnroll.net/) +- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) +- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Plugins/Reqnroll.MSTest.ReqnrollPlugin/Reqnroll.MSTest.ReqnrollPlugin.csproj b/Plugins/Reqnroll.MSTest.ReqnrollPlugin/Reqnroll.MSTest.ReqnrollPlugin.csproj index cc16bdcb0..bd4516327 100644 --- a/Plugins/Reqnroll.MSTest.ReqnrollPlugin/Reqnroll.MSTest.ReqnrollPlugin.csproj +++ b/Plugins/Reqnroll.MSTest.ReqnrollPlugin/Reqnroll.MSTest.ReqnrollPlugin.csproj @@ -3,6 +3,8 @@ netstandard2.0 true + true + $(NoWarn);1591 Reqnroll.MSTest diff --git a/Plugins/Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin/README.md b/Plugins/Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin/README.md new file mode 100644 index 000000000..d4d912165 --- /dev/null +++ b/Plugins/Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin/README.md @@ -0,0 +1,13 @@ +Reqnroll.Microsoft.Extensions.DependencyInjection provides [Microsoft.Extensions.DependencyInjection](https://learn.microsoft.com/en-us/dotnet/core/extensions/dependency-injection-usage) integration for Reqnroll. + +This package enables Reqnroll to use the dependency injection container from the Microsoft.Extensions.DependencyInjection package for resolving step definitions, hooks, and other dependencies in your BDD tests. + +## Documentation + +For more information about using dependency injection with Reqnroll, see [Microsoft.Extensions.DependencyInjection - Reqnroll documentation](https://docs.reqnroll.net/latest/integrations/dependency-injection.html). + +## Support + +- [Reqnroll Documentation](https://docs.reqnroll.net/) +- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) +- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Plugins/Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin/Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin.csproj b/Plugins/Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin/Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin.csproj index 937483e46..a28a9d53f 100644 --- a/Plugins/Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin/Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin.csproj +++ b/Plugins/Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin/Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin.csproj @@ -5,10 +5,12 @@ enable true true + true + $(NoWarn);1591 Reqnroll.Microsoft.Extensions.DependencyInjection - reqnroll verify xunit + reqnroll microsoft extensions di dependency injection Reqnroll Microsoft.Extensions.DependencyInjection integration plugin Reqnroll plugin that enables to use Microsoft.Extensions.DependencyInjection for resolving test dependencies. Mark Hoek, Solid Token, Stef Heyenrath, $(ReqnrollAuthors) diff --git a/Plugins/Reqnroll.NUnit.Generator.ReqnrollPlugin/README.md b/Plugins/Reqnroll.NUnit.Generator.ReqnrollPlugin/README.md new file mode 100644 index 000000000..e5cc1c7b9 --- /dev/null +++ b/Plugins/Reqnroll.NUnit.Generator.ReqnrollPlugin/README.md @@ -0,0 +1,13 @@ +Reqnroll.NUnit enables using Reqnroll with [NUnit test framework](https://nunit.org/). + +This package provides integration between Reqnroll and NUnit, allowing you to write BDD tests using Gherkin syntax that run with the NUnit test framework. + +## Documentation + +For more information about using Reqnroll with NUnit, see [NUnit - Reqnroll documentation](https://docs.reqnroll.net/latest/integrations/nunit.html). + +## Support + +- [Reqnroll Documentation](https://docs.reqnroll.net/) +- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) +- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Plugins/Reqnroll.NUnit.ReqnrollPlugin/Reqnroll.NUnit.ReqnrollPlugin.csproj b/Plugins/Reqnroll.NUnit.ReqnrollPlugin/Reqnroll.NUnit.ReqnrollPlugin.csproj index a9ac93ed4..ee90f0881 100644 --- a/Plugins/Reqnroll.NUnit.ReqnrollPlugin/Reqnroll.NUnit.ReqnrollPlugin.csproj +++ b/Plugins/Reqnroll.NUnit.ReqnrollPlugin/Reqnroll.NUnit.ReqnrollPlugin.csproj @@ -3,6 +3,8 @@ netstandard2.0 true + true + $(NoWarn);1591 Reqnroll.NUnit @@ -12,7 +14,7 @@ - + diff --git a/Plugins/Reqnroll.SpecFlowCompatibility.Generator.ReqnrollPlugin/README.md b/Plugins/Reqnroll.SpecFlowCompatibility.Generator.ReqnrollPlugin/README.md new file mode 100644 index 000000000..9f824ff5b --- /dev/null +++ b/Plugins/Reqnroll.SpecFlowCompatibility.Generator.ReqnrollPlugin/README.md @@ -0,0 +1,9 @@ +Reqnroll.SpecFlowCompatibility provides compatibility layer for migrating from SpecFlow to Reqnroll. + +This package helps ease the [migration from SpecFlow](https://docs.reqnroll.net/latest/guides/migrating-from-specflow.html) by providing compatibility shims and adapters, allowing you to gradually migrate your existing SpecFlow tests to Reqnroll. + +## Support + +- [Reqnroll Documentation](https://docs.reqnroll.net/) +- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) +- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Plugins/Reqnroll.SpecFlowCompatibility.ReqnrollPlugin/Reqnroll.SpecFlowCompatibility.ReqnrollPlugin.csproj b/Plugins/Reqnroll.SpecFlowCompatibility.ReqnrollPlugin/Reqnroll.SpecFlowCompatibility.ReqnrollPlugin.csproj index dc5cd0146..3021a4a65 100644 --- a/Plugins/Reqnroll.SpecFlowCompatibility.ReqnrollPlugin/Reqnroll.SpecFlowCompatibility.ReqnrollPlugin.csproj +++ b/Plugins/Reqnroll.SpecFlowCompatibility.ReqnrollPlugin/Reqnroll.SpecFlowCompatibility.ReqnrollPlugin.csproj @@ -2,6 +2,7 @@ netstandard2.0;net462 true + true true @@ -12,7 +13,7 @@ reqnroll specflow - $(NoWarn);NU5100;NU5118 + $(NoWarn);NU5100;NU5118;1591 diff --git a/Plugins/Reqnroll.TUnit.Generator.ReqnrollPlugin/README.md b/Plugins/Reqnroll.TUnit.Generator.ReqnrollPlugin/README.md new file mode 100644 index 000000000..bff5e3e7f --- /dev/null +++ b/Plugins/Reqnroll.TUnit.Generator.ReqnrollPlugin/README.md @@ -0,0 +1,9 @@ +Reqnroll.TUnit enables using Reqnroll with TUnit test framework. + +This package provides integration between Reqnroll and [TUnit](https://tunit.dev/), allowing you to write BDD tests using Gherkin syntax that run with the TUnit test framework. + +## Support + +- [Reqnroll Documentation](https://docs.reqnroll.net/) +- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) +- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Plugins/Reqnroll.TUnit.Generator.ReqnrollPlugin/Reqnroll.TUnit.Generator.ReqnrollPlugin.csproj b/Plugins/Reqnroll.TUnit.Generator.ReqnrollPlugin/Reqnroll.TUnit.Generator.ReqnrollPlugin.csproj index 95dfdbaf8..195aecf45 100644 --- a/Plugins/Reqnroll.TUnit.Generator.ReqnrollPlugin/Reqnroll.TUnit.Generator.ReqnrollPlugin.csproj +++ b/Plugins/Reqnroll.TUnit.Generator.ReqnrollPlugin/Reqnroll.TUnit.Generator.ReqnrollPlugin.csproj @@ -3,5 +3,7 @@ netstandard2.0 true false + true + $(NoWarn);1591 diff --git a/Plugins/Reqnroll.TUnit.ReqnrollPlugin/Reqnroll.TUnit.ReqnrollPlugin.csproj b/Plugins/Reqnroll.TUnit.ReqnrollPlugin/Reqnroll.TUnit.ReqnrollPlugin.csproj index f28dbf739..314a235f0 100644 --- a/Plugins/Reqnroll.TUnit.ReqnrollPlugin/Reqnroll.TUnit.ReqnrollPlugin.csproj +++ b/Plugins/Reqnroll.TUnit.ReqnrollPlugin/Reqnroll.TUnit.ReqnrollPlugin.csproj @@ -2,12 +2,13 @@ netstandard2.0 true + $(NoWarn);1591 + true Reqnroll.TUnit Package to use Reqnroll with TUnit 1.3.25 and later. reqnroll TUnit - true README.md diff --git a/Plugins/Reqnroll.Verify/Reqnroll.Verify.ReqnrollPlugin/README.md b/Plugins/Reqnroll.Verify/Reqnroll.Verify.ReqnrollPlugin/README.md new file mode 100644 index 000000000..bc8a0a169 --- /dev/null +++ b/Plugins/Reqnroll.Verify/Reqnroll.Verify.ReqnrollPlugin/README.md @@ -0,0 +1,13 @@ +Reqnroll.Verify provides integration with [Verify](https://github.com/VerifyTests/Verify) for snapshot testing in Reqnroll scenarios. + +This package enables Reqnroll to use Verify for approval/snapshot testing, allowing you to verify complex objects, text outputs, and other test results using the Verify library. + +## Documentation + +For more information about using Verify with Reqnroll, see [Verify - Reqnroll documentation](https://docs.reqnroll.net/latest/integrations/verify.html). + +## Support + +- [Reqnroll Documentation](https://docs.reqnroll.net/) +- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) +- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Plugins/Reqnroll.Verify/Reqnroll.Verify.ReqnrollPlugin/Reqnroll.Verify.ReqnrollPlugin.csproj b/Plugins/Reqnroll.Verify/Reqnroll.Verify.ReqnrollPlugin/Reqnroll.Verify.ReqnrollPlugin.csproj index 276958532..508f4d8b6 100644 --- a/Plugins/Reqnroll.Verify/Reqnroll.Verify.ReqnrollPlugin/Reqnroll.Verify.ReqnrollPlugin.csproj +++ b/Plugins/Reqnroll.Verify/Reqnroll.Verify.ReqnrollPlugin/Reqnroll.Verify.ReqnrollPlugin.csproj @@ -5,6 +5,9 @@ Reqnroll.Verify + true + $(NoWarn);1591 + true Package to use Verify.Xunit with Reqnroll reqnroll verify xunit diff --git a/Plugins/Reqnroll.Windsor.ReqnrollPlugin/README.md b/Plugins/Reqnroll.Windsor.ReqnrollPlugin/README.md new file mode 100644 index 000000000..0d281c54b --- /dev/null +++ b/Plugins/Reqnroll.Windsor.ReqnrollPlugin/README.md @@ -0,0 +1,13 @@ +Reqnroll.Windsor provides [Castle Windsor](https://github.com/castleproject/Windsor) dependency injection integration for Reqnroll. + +This package enables Reqnroll to use Castle Windsor as the dependency injection container for resolving step definitions, hooks, and other dependencies in your BDD tests. + +## Documentation + +For more information about using dependency injection with Reqnroll, see [Castle Windsor - Reqnroll documentation](https://docs.reqnroll.net/latest/integrations/windsor.html). + +## Support + +- [Reqnroll Documentation](https://docs.reqnroll.net/) +- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) +- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Plugins/Reqnroll.Windsor.ReqnrollPlugin/Reqnroll.Windsor.ReqnrollPlugin.csproj b/Plugins/Reqnroll.Windsor.ReqnrollPlugin/Reqnroll.Windsor.ReqnrollPlugin.csproj index b589f9d62..50930bd24 100644 --- a/Plugins/Reqnroll.Windsor.ReqnrollPlugin/Reqnroll.Windsor.ReqnrollPlugin.csproj +++ b/Plugins/Reqnroll.Windsor.ReqnrollPlugin/Reqnroll.Windsor.ReqnrollPlugin.csproj @@ -5,6 +5,8 @@ Reqnroll.Windsor + true + $(NoWarn);1591 reqnroll castle windsor di dependency injection Reqnroll Windsor integration plugin Reqnroll plugin that enables to use Windsor for resolving test dependencies. diff --git a/Plugins/Reqnroll.xUnit.Generator.ReqnrollPlugin/README.md b/Plugins/Reqnroll.xUnit.Generator.ReqnrollPlugin/README.md new file mode 100644 index 000000000..42f5633ee --- /dev/null +++ b/Plugins/Reqnroll.xUnit.Generator.ReqnrollPlugin/README.md @@ -0,0 +1,15 @@ +Reqnroll.xUnit enables using Reqnroll with [xUnit test framework v2](https://xunit.net/docs/getting-started/v2/getting-started). + +For xUnit 2, use the package Reqnroll.xunit.v3 + +This package provides integration between Reqnroll and xUnit, allowing you to write BDD tests using Gherkin syntax that run with the xUnit test framework. + +## Documentation + +For more information about using Reqnroll with xUnit, see [xUnit - Reqnroll documentation](https://docs.reqnroll.net/latest/integrations/xunit.html). + +## Support + +- [Reqnroll Documentation](https://docs.reqnroll.net/) +- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) +- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Plugins/Reqnroll.xUnit.ReqnrollPlugin/Reqnroll.xUnit.ReqnrollPlugin.csproj b/Plugins/Reqnroll.xUnit.ReqnrollPlugin/Reqnroll.xUnit.ReqnrollPlugin.csproj index 0cf085f4a..f68b8a52f 100644 --- a/Plugins/Reqnroll.xUnit.ReqnrollPlugin/Reqnroll.xUnit.ReqnrollPlugin.csproj +++ b/Plugins/Reqnroll.xUnit.ReqnrollPlugin/Reqnroll.xUnit.ReqnrollPlugin.csproj @@ -2,6 +2,8 @@ netstandard2.0;net462 true + true + $(NoWarn);1591 Reqnroll.xUnit diff --git a/Plugins/Reqnroll.xUnit3.Generator.ReqnrollPlugin/README.md b/Plugins/Reqnroll.xUnit3.Generator.ReqnrollPlugin/README.md new file mode 100644 index 000000000..a42d73510 --- /dev/null +++ b/Plugins/Reqnroll.xUnit3.Generator.ReqnrollPlugin/README.md @@ -0,0 +1,15 @@ +Reqnroll.xUnit enables using Reqnroll with [xUnit test framework v3](https://xunit.net/docs/getting-started/v3/getting-started). + +For xUnit 2, use the package Reqnroll.xUnit + +This package provides integration between Reqnroll and xUnit, allowing you to write BDD tests using Gherkin syntax that run with the xUnit test framework. + +## Documentation + +For more information about using Reqnroll with xUnit, see [xUnit - Reqnroll documentation](https://docs.reqnroll.net/latest/integrations/xunit.html). + +## Support + +- [Reqnroll Documentation](https://docs.reqnroll.net/) +- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) +- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Plugins/Reqnroll.xUnit3.ReqnrollPlugin/Reqnroll.xUnit3.ReqnrollPlugin.csproj b/Plugins/Reqnroll.xUnit3.ReqnrollPlugin/Reqnroll.xUnit3.ReqnrollPlugin.csproj index 0599fa0af..64ea2ef87 100644 --- a/Plugins/Reqnroll.xUnit3.ReqnrollPlugin/Reqnroll.xUnit3.ReqnrollPlugin.csproj +++ b/Plugins/Reqnroll.xUnit3.ReqnrollPlugin/Reqnroll.xUnit3.ReqnrollPlugin.csproj @@ -2,6 +2,8 @@ netstandard2.0 true + true + $(NoWarn);1591 Reqnroll.xunit.v3 diff --git a/Reqnroll.Generator/README.md b/Reqnroll.Generator/README.md new file mode 100644 index 000000000..d6159514f --- /dev/null +++ b/Reqnroll.Generator/README.md @@ -0,0 +1,20 @@ +Reqnroll.Generator is the code generation component of the Reqnroll framework. + +This package provides code generation capabilities that convert Gherkin feature files into executable test code for the Reqnroll BDD test automation framework for .NET. For generator configuration options, see the [Generator Configuration Documentation](https://docs.reqnroll.net/latest/installation/configuration.html#generator). + +## Key Features + +- **Code Generation**: Converts Gherkin feature files into C# test code +- **Test Framework Integration**: Supports multiple test frameworks (MSTest, NUnit, xUnit) +- **Binding Generation**: Generates binding code and step definition skeletons +- **Multiple Target Frameworks**: Supports .NET Standard 2.0 and later + +## Documentation + +For more information about Reqnroll and its components, visit the [documentation](https://docs.reqnroll.net/). + +## Support + +- [Reqnroll Documentation](https://docs.reqnroll.net/) +- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) +- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Reqnroll.Generator/Reqnroll.Generator.csproj b/Reqnroll.Generator/Reqnroll.Generator.csproj index f4efdaefe..bbedd9edb 100644 --- a/Reqnroll.Generator/Reqnroll.Generator.csproj +++ b/Reqnroll.Generator/Reqnroll.Generator.csproj @@ -8,12 +8,19 @@ Reqnroll.Generator $(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb + true + README.md + $(NoWarn);1591 + + + + diff --git a/Reqnroll.Parser/README.md b/Reqnroll.Parser/README.md new file mode 100644 index 000000000..3bb2ea219 --- /dev/null +++ b/Reqnroll.Parser/README.md @@ -0,0 +1,20 @@ +Reqnroll.Parser is the Gherkin parsing component of the Reqnroll framework. + +This package provides Gherkin feature file parsing capabilities that convert Gherkin syntax into structured data models for the Reqnroll BDD test automation framework for .NET. + +## Key Features + +- **Gherkin Parsing**: Parses `.feature` files written in Gherkin syntax +- **Structured Output**: Converts Gherkin files into structured data models +- **Multi-language Support**: Supports Gherkin keywords in multiple languages +- **Error Handling**: Provides detailed parsing error information + +## Documentation + +For more information about Reqnroll and its components, visit the [documentation](https://docs.reqnroll.net/). + +## Support + +- [Reqnroll Documentation](https://docs.reqnroll.net/) +- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) +- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Reqnroll.Parser/Reqnroll.Parser.csproj b/Reqnroll.Parser/Reqnroll.Parser.csproj index 83caa23b9..1b5a9a2b0 100644 --- a/Reqnroll.Parser/Reqnroll.Parser.csproj +++ b/Reqnroll.Parser/Reqnroll.Parser.csproj @@ -8,12 +8,19 @@ Reqnroll.Parser $(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb + true + README.md + $(NoWarn);1591 + + + + diff --git a/Reqnroll.Tools.MsBuild.Generation/README.md b/Reqnroll.Tools.MsBuild.Generation/README.md new file mode 100644 index 000000000..484606eaf --- /dev/null +++ b/Reqnroll.Tools.MsBuild.Generation/README.md @@ -0,0 +1,29 @@ +Reqnroll.Tools.MsBuild.Generation enables code-behind file generation during build time for Reqnroll projects. + +This package provides MSBuild tasks and targets that automatically generate test code from Gherkin feature files during the build process, eliminating the need for manual code generation. + +## Key Features + +- **Build-Time Code Generation**: Automatically generates test code during MSBuild process +- **Multi-Targeting Support**: Works with both .NET Framework and .NET Core projects +- **Custom Build Configuration**: Configurable build options and target frameworks +- **IDE Integration**: Seamless integration with Visual Studio and other IDEs + +## Usage + +This package is automatically included when you install one of the Reqnroll test framework packages: +- Reqnroll.MSTest +- Reqnroll.NUnit +- Reqnroll.TUnit +- Reqnroll.xUnit + +## Documentation + +For more information about build configuration and code generation, see: +- [Configuring Build](https://docs.reqnroll.net/latest/installation/configuring-build.html) + +## Support + +- [Reqnroll Documentation](https://docs.reqnroll.net/) +- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) +- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Reqnroll.Tools.MsBuild.Generation/Reqnroll.Tools.MsBuild.Generation.csproj b/Reqnroll.Tools.MsBuild.Generation/Reqnroll.Tools.MsBuild.Generation.csproj index 6a525266b..5b8d40521 100644 --- a/Reqnroll.Tools.MsBuild.Generation/Reqnroll.Tools.MsBuild.Generation.csproj +++ b/Reqnroll.Tools.MsBuild.Generation/Reqnroll.Tools.MsBuild.Generation.csproj @@ -7,6 +7,8 @@ true false + true + $(NoWarn);1591 true diff --git a/Reqnroll.Utils/README.md b/Reqnroll.Utils/README.md new file mode 100644 index 000000000..c517cd90a --- /dev/null +++ b/Reqnroll.Utils/README.md @@ -0,0 +1,20 @@ +Reqnroll.Utils provides utility classes and helper functions for the Reqnroll framework. + +This package contains common utilities and helper classes used by various components of the Reqnroll BDD test automation framework for .NET. + +## Key Features + +- **Common Utilities**: Shared utility classes and helper methods +- **Configuration Helpers**: Configuration-related utility functions +- **File System Utilities**: File and directory manipulation helpers +- **Extension Methods**: Commonly used extension methods + +## Documentation + +For more information about Reqnroll and its components, visit the [documentation](https://docs.reqnroll.net/). + +## Support + +- [Reqnroll Documentation](https://docs.reqnroll.net/) +- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) +- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Reqnroll.Utils/Reqnroll.Utils.csproj b/Reqnroll.Utils/Reqnroll.Utils.csproj index d7ca1ede2..82cfa5a57 100644 --- a/Reqnroll.Utils/Reqnroll.Utils.csproj +++ b/Reqnroll.Utils/Reqnroll.Utils.csproj @@ -8,5 +8,12 @@ $(ReqnrollKeyFile) $(ReqnrollEnableStrongNameSigning) $(ReqnrollPublicSign) + true + README.md + $(NoWarn);1591 + + + + diff --git a/Reqnroll/README.md b/Reqnroll/README.md new file mode 100644 index 000000000..467159dea --- /dev/null +++ b/Reqnroll/README.md @@ -0,0 +1,3 @@ +Reqnroll (pronounced as [reknroʊl]) is an open-source Cucumber-style BDD test automation framework for .NET. It has been created as a reboot of the SpecFlow project. + +Reqnroll enables writing executable specifications for BDD using Gherkin, the widely-accepted *feature file* specification format. With that you can define the requirements using *Given-When-Then* style *scenarios* and turn them to automated tests in order to verify their implementation. diff --git a/Templates/Reqnroll.Templates.DotNet/README.md b/Templates/Reqnroll.Templates.DotNet/README.md new file mode 100644 index 000000000..5ef40247a --- /dev/null +++ b/Templates/Reqnroll.Templates.DotNet/README.md @@ -0,0 +1,42 @@ +Reqnroll.Templates.DotNet provides dotnet new templates for creating Reqnroll projects and files. + +This package contains project templates and item templates that can be used with the `dotnet new` command to quickly scaffold Reqnroll projects and add common files to existing projects. + +## Key Features + +- **Project Templates**: Templates for creating new Reqnroll projects with different test frameworks +- **Item Templates**: Templates for adding Reqnroll configuration files and feature files +- **Test Framework Support**: Templates for MSTest, NUnit, and xUnit projects + +## Installation + +Install the templates globally to use with dotnet new: + +```powershell +dotnet new install Reqnroll.Templates.DotNet +``` + +## Usage + +After installation, you can create new projects and files: + +```powershell +# Create a new Reqnroll project +dotnet new reqnroll-project + +# Add a configuration file +dotnet new reqnroll-config + +# Add a feature file +dotnet new reqnroll-feature +``` + +## Documentation + +For more information about Reqnroll templates and getting started, visit the [Reqnroll documentation](https://docs.reqnroll.net/). + +## Support + +- [Reqnroll Documentation](https://docs.reqnroll.net/) +- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues) +- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions) \ No newline at end of file diff --git a/Templates/Reqnroll.Templates.DotNet/Reqnroll.Templates.DotNet.csproj b/Templates/Reqnroll.Templates.DotNet/Reqnroll.Templates.DotNet.csproj index 77ac4017a..850479e94 100644 --- a/Templates/Reqnroll.Templates.DotNet/Reqnroll.Templates.DotNet.csproj +++ b/Templates/Reqnroll.Templates.DotNet/Reqnroll.Templates.DotNet.csproj @@ -15,6 +15,7 @@ true true false + README.md false true @@ -25,6 +26,7 @@ +