cucumber / docs

Cucumber user documentation
https://cucumber.io/docs/installation/
MIT License
149 stars 525 forks source link

change doc for junit5 #487

Open toepi opened 4 years ago

toepi commented 4 years ago

have found the the documention is a little outdate to use cucumber with junit5, it reference to junit-vintage-engine. with is only correct if cucumber-junit will be used. since cucumber 5 it is possible to use junit5 native with cucumber-junit-platform-engine.

Why no pr? I'm unsure how to describe it in a good manner. Have only found out that the current stand is confusing new users.

mlvandijk commented 3 years ago

Hi @toepi - Thanks you for creating this issue. Would you be open to collaborating on a PR? You can get started by changing the things you have found to be outdated and people can review / add suggestion?

mpkorstanje commented 3 years ago

@mlvandijk I'm waiting for https://github.com/junit-team/junit5/pull/2416. Once implemented we'll be feature complete with Junit 4.

mlvandijk commented 3 years ago

Good to know, thnx @mpkorstanje

jimshowalter commented 3 years ago

Is there even a sketch somewhere of how to use native JUnit 5 with cucumber-junit-platform-engine while excluding junit and the vintage engine? We added cucumber-junit-platform-engine and excluded junit and the vintage engine, and now it runs but says there are no tests. Adding back the vintage engine, it finds our tests. A working example posted to some public repo somewhere would be extremely useful, in lieu of documentation.

jimshowalter commented 3 years ago

Here's a working example. I cloned it, added excludes of junit and vintage engine, and it still works: https://github.com/cronn/cucumber-junit5-example

mpkorstanje commented 3 years ago

This should help:

https://github.com/cucumber/cucumber-jvm/tree/main/junit-platform-engine

jimshowalter commented 3 years ago

I'd read that, but nothing beats a checked-in, working example.