Skip to content

Commit

Permalink
docs: update Readme.md for Specflow migration to Reqnroll
Browse files Browse the repository at this point in the history
  • Loading branch information
AndreaCuneo committed Oct 23, 2024
1 parent 403556d commit 55a2f9c
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,21 @@ The main library used by Ark in its stack are
If you want to learn more about each project, look the respective Readme when present or directly at code.
Documentation improvements are up-for-grabs ;)

## Migrate from Specflow to Reqnroll (v5.1)

**Support for Speflow is no longer mainteined and will be removed in next Major.**

The ReferenceProject has been migrated from Specflow to Reqnroll. For reasons you can read [this](https://reqnroll.net/news/2024/02/from-specflow-to-reqnroll-why-and-how/) but long story short: Specflow is no longer mainteined.

`Ark.Tools.Reqnroll` replaces `Ark.Tools.Specflow`: the only changes are in `namespace`.

To migrate:
1. Replace `Techtalk.Specflow` to `Reqnroll` in `using`
1. Replace `Ark.Tools.Specflow` to `Ark.Tools.Reqnroll` in both `using` and `PackageReference`
1. Replace `Specflow.*` to `Reqnroll.*` in `PackageReference`
1. Add [`reqnroll.json`](./ArkReferenceProject/Core/Tests/reqnroll.json) to test projects
1. Fix Verbs: Reqnroll default to Gherking style parameters instead of Regex style thus it might be required to update verbs as described [here](https://docs.reqnroll.net/latest/guides/migrating-from-specflow.html#cucumber-expressions-support-compatibility-of-existing-expressions), specifying the regex start/end markers (^/$).

## Ark.Tools v5 Breaking Changes

### .NET 8.0
Expand Down

0 comments on commit 55a2f9c

Please sign in to comment.