Skip to content
This repository was archived by the owner on Dec 21, 2024. It is now read-only.

Commit 7faf2da

Browse files
committed
Update links to Cucumber JVM
With cucumber/cucumber-jvm#2596 the internal structure got changed somewhat. Updated all the documentation links to match these changes.
1 parent 2545d18 commit 7faf2da

File tree

10 files changed

+28
-28
lines changed

10 files changed

+28
-28
lines changed

content/docs/community/faq.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -77,11 +77,11 @@ For information on how to run the Cucumber CLI, see [From the command line](/doc
7777
For information about configuration options, see [Configuration](/docs/cucumber/configuration/).
7878

7979
{{% block "java,kotlin" %}}
80-
When using JUnit 5, reference the [cucumber-junit-platform-engine documentation](https://github.com/cucumber/cucumber-jvm/tree/main/junit-platform-engine).
80+
When using JUnit 5, reference the [cucumber-junit-platform-engine documentation](https://github.com/cucumber/cucumber-jvm/tree/main/cucumber-junit-platform-engine).
8181

8282
When running Cucumber with JUnit 4, you can specify several options on how JUnit 4 should run your tests.
8383
Check the section on [JUnit](https://docs.cucumber.io/cucumber/api/#junit) for more information. For more
84-
details about the available CucumberOptions, check the [code](https://github.com/cucumber/cucumber-jvm/blob/main/core/src/test/java/io/cucumber/core/options/CucumberOptions.java).
84+
details about the available CucumberOptions, check the [code](https://github.com/cucumber/cucumber-jvm/blob/main/cucumber-junit/src/main/java/io/cucumber/junit/CucumberOptions.java).
8585

8686

8787
{{% /block %}}
@@ -142,11 +142,11 @@ You can find the required dependencies [here](https://docs.cucumber.io/installat
142142
{{% /block %}}
143143

144144
{{% block "java" %}}
145-
For an example on how to use them, see this [code example](https://github.com/cucumber/cucumber-jvm/blob/main/examples/java8-calculator/src/test/java/io/cucumber/examples/java8/RpnCalculatorSteps.java).
145+
For an example on how to use them, see this [code example](https://github.com/cucumber/cucumber-jvm/blob/main/examples/calculator-java8-cli/src/test/java/io/cucumber/examples/calculator/RpnCalculatorSteps.java).
146146
{{% /block %}}
147147

148148
{{% block "kotlin" %}}
149-
For an example on how to use them, see this [code example](https://github.com/cucumber/cucumber-jvm/blob/main/kotlin-java8/src/test/kotlin/io/cucumber/kotlin/LambdaStepDefinitions.kt).
149+
For an example on how to use them, see this [code example](https://github.com/cucumber/cucumber-jvm/blob/main/cucumber-kotlin-java8/src/test/kotlin/io/cucumber/kotlin/LambdaStepDefinitions.kt).
150150
{{% /block %}}
151151

152152
## How do I call other steps or scenarios?
@@ -254,7 +254,7 @@ multiple steps might match the same expression. Finally, this means that you can
254254
definitions, as that will lead to duplicates.
255255

256256
# Does Cucumber-JVM support Kotlin?
257-
You can use [Cucumber-JVM](https://github.com/cucumber/cucumber-jvm) to write step definitions in Kotlin. Please have a look at the [Kotlin examples for cucumber-jvm](https://github.com/cucumber/cucumber-jvm/tree/master/kotlin-java8).
257+
You can use [Cucumber-JVM](https://github.com/cucumber/cucumber-jvm) to write step definitions in Kotlin. Please have a look at the [Kotlin examples for cucumber-jvm](https://github.com/cucumber/cucumber-jvm/tree/master/cucumber-kotlin-java8).
258258
At the moment it is not possible to generate step definitions in Kotlin. The reason for this is that there is no Kotlin Backend implemented. If this is something you'd like to work on, there is [a request for one](https://github.com/cucumber/cucumber-jvm/issues/1520). There is also a request for a [native Kotlin implementation of Cucumber](https://github.com/cucumber/cucumber/issues/331).
259259

260260
# Cucumber can't find my step definitions in IntelliJ IDEA

content/docs/community/not-cucumber.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ For more information see the [Karate project on GitHub](https://github.com/intui
113113
{{% text "java,kotlin" %}}
114114
If you are having issues when using TestNG with Cucumber-JVM, please check that you are using the version of TestNG that Cucumber-JVM was build against.
115115

116-
For an example of how to use TestNG with Cucumber, see the [java-calculator-testng example](https://github.com/cucumber/cucumber-jvm/tree/main/examples/java-calculator-testng).
116+
For an example of how to use TestNG with Cucumber, see the [java-calculator-testng example](https://github.com/cucumber/cucumber-jvm/tree/main/examples/calculator-java-testng).
117117
{{% /text %}}
118118

119119
{{% text "ruby,javascript" %}}TestNG is only available for Java and Kotlin.{{% /text %}}

content/docs/cucumber/api.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ See [Github](https://github.com/cucumber/cucumber-jvm-scala/issues/50).
8888
[here](https://github.com/cucumber/cucumber-js/blob/master/src/models/data_table.ts) {{% /text %}}
8989

9090
{{% text "java,kotlin" %}}In addition, see
91-
[cucumber-jvm data-tables](https://github.com/cucumber/cucumber-jvm/tree/main/java#data-tables){{% /text %}}
91+
[cucumber-jvm data-tables](https://github.com/cucumber/cucumber-jvm/tree/main/cucumber-java#data-tables){{% /text %}}
9292

9393
# Steps
9494

@@ -812,7 +812,7 @@ Tags that are placed above a `Scenario Outline` will be inherited by `Examples`.
812812
You can tell Cucumber to only run scenarios with a particular tag:
813813

814814
{{% block "java,kotlin,scala" %}}
815-
For JUnit 5 see the [cucumber-junit-platform-engine documetation](https://github.com/cucumber/cucumber-jvm/tree/main/junit-platform-engine#tags).
815+
For JUnit 5 see the [cucumber-junit-platform-engine documetation](https://github.com/cucumber/cucumber-jvm/tree/main/cucumber-junit-platform-engine#tags).
816816

817817
For JUnit 4 and TestNG using a JVM system property:
818818

@@ -1113,7 +1113,7 @@ You can also run features using a [build tool](/docs/tools/general#build-tools)
11131113
## JUnit 5
11141114

11151115
{{% block "java,kotlin,scala" %}}
1116-
See the [cucumber-junit-platform-engine documentation](https://github.com/cucumber/cucumber-jvm/tree/main/junit-platform-engine#configuration-options)
1116+
See the [cucumber-junit-platform-engine documentation](https://github.com/cucumber/cucumber-jvm/tree/main/cucumber-junit-platform-engine#configuration-options)
11171117
{{% /block %}}
11181118

11191119
{{% block "ruby" %}}
@@ -1141,7 +1141,7 @@ To use JUnit to execute cucumber scenarios add the `cucumber-junit` dependency t
11411141
[...]
11421142
</dependencies>
11431143
```
1144-
Note that `cucumber-junit` is based on JUnit 4. If you're using JUnit 5, use the [cucumber-junit-platform-engine](https://github.com/cucumber/cucumber-jvm/tree/main/junit-platform-engine).
1144+
Note that `cucumber-junit` is based on JUnit 4. If you're using JUnit 5, use the [cucumber-junit-platform-engine](https://github.com/cucumber/cucumber-jvm/tree/main/cucumber-junit-platform-engine).
11451145
Or include `junit-vintage-engine` dependency, as well. For more information, please refer to [JUnit 5 documentation](https://junit.org/junit5/docs/current/user-guide/#migrating-from-junit4-running).
11461146

11471147
Create an empty class that uses the Cucumber JUnit runner.
@@ -1555,7 +1555,7 @@ properties file and CLI arguments take precedence over all.
15551555

15561556
Note that the `cucumber-junit-platform-engine` is provided with properties
15571557
by the Junit Platform rather than Cucumber. See
1558-
[junit-platform-engine Configuration Options](https://github.com/cucumber/cucumber-jvm/tree/main/junit-platform-engine#configuration-options)
1558+
[junit-platform-engine Configuration Options](https://github.com/cucumber/cucumber-jvm/tree/main/cucumber-junit-platform-engine#configuration-options)
15591559
for more information.
15601560

15611561
For example, if you are using Maven and want to run a subset of scenarios tagged

content/docs/cucumber/checking-assertions.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ from a unit testing tool.
1313

1414
## JUnit 5
1515

16-
When using the [cucumber-junit-platform-engine](https://github.com/cucumber/cucumber-jvm/tree/main/junit-platform-engine)
16+
When using the [cucumber-junit-platform-engine](https://github.com/cucumber/cucumber-jvm/tree/main/cucumber-junit-platform-engine)
1717
you are free to use any assertion library of your choice. For example:
1818

1919
* [AssertJ](https://assertj.github.io/doc/)

content/docs/cucumber/state.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ Or, if you are using Gradle, add:
147147
compile group: 'io.cucumber', name: 'cucumber-picocontainer', version: '{{% version "cucumberjvm" %}}'
148148
```
149149

150-
There is no documentation yet, but the code is on [GitHub](https://github.com/cucumber/cucumber-jvm/tree/main/picocontainer).
150+
There is no documentation yet, but the code is on [GitHub](https://github.com/cucumber/cucumber-jvm/tree/main/cucumber-picocontainer).
151151
For more information, please see [sharing state using PicoContainer](http://www.thinkcode.se/blog/2017/04/01/sharing-state-between-steps-in-cucumberjvm-using-picocontainer).
152152
{{% /block %}}
153153

@@ -172,7 +172,7 @@ Or, if you are using Gradle, add:
172172
compile group: 'io.cucumber', name: 'cucumber-spring', version: '{{% version "cucumberjvm" %}}'
173173
```
174174

175-
There is no documentation yet, but the code is on [GitHub](https://github.com/cucumber/cucumber-jvm/tree/main/spring).
175+
There is no documentation yet, but the code is on [GitHub](https://github.com/cucumber/cucumber-jvm/tree/main/cucumber-spring).
176176
{{% /block %}}
177177

178178
{{% block "ruby,javascript" %}} Spring is a Dependency Injection framework for JVM languages. {{% /block %}}
@@ -195,7 +195,7 @@ Or, if you are using Gradle, add:
195195
compile group: 'io.cucumber', name: 'cucumber-guice', version: '{{% version "cucumberjvm" %}}'
196196
```
197197

198-
There is no documentation yet, but the code is on [GitHub](https://github.com/cucumber/cucumber-jvm/tree/main/guice).
198+
There is no documentation yet, but the code is on [GitHub](https://github.com/cucumber/cucumber-jvm/tree/main/cucumber-guice).
199199
For more information, please see [sharing state using Guice](http://www.thinkcode.se/blog/2017/08/16/sharing-state-between-steps-in-cucumberjvm-using-guice).
200200
{{% /block %}}
201201

@@ -219,7 +219,7 @@ Or, if you are using Gradle, add:
219219
compile group: 'io.cucumber', name: 'cucumber-openejb', version: '{{% version "cucumberjvm" %}}'
220220
```
221221

222-
There is no documentation yet, but the code is on [GitHub](https://github.com/cucumber/cucumber-jvm/tree/main/openejb).
222+
There is no documentation yet, but the code is on [GitHub](https://github.com/cucumber/cucumber-jvm/tree/main/cucumber-openejb).
223223
{{% /block %}}
224224

225225
{{% block "ruby,javascript" %}} OpenEJB is a Dependency Injection framework for JVM languages. {{% /block %}}
@@ -242,7 +242,7 @@ Or, if you are using Gradle, add:
242242
compile group: 'io.cucumber', name: 'cucumber-weld', version: '{{% version "cucumberjvm" %}}'
243243
```
244244

245-
There is no documentation yet, but the code is on [GitHub](https://github.com/cucumber/cucumber-jvm/tree/main/weld).
245+
There is no documentation yet, but the code is on [GitHub](https://github.com/cucumber/cucumber-jvm/tree/main/cucumber-weld).
246246
{{% /block %}}
247247

248248
{{% block "ruby,javascript" %}} Weld is a Dependency Injection framework for JVM languages. {{% /block %}}
@@ -265,7 +265,7 @@ Or, if you are using Gradle, add:
265265
compile group: 'io.cucumber', name: 'cucumber-needle', version: '{{% version "cucumberjvm" %}}'
266266
```
267267

268-
There is no documentation yet, but the code is on [GitHub](https://github.com/cucumber/cucumber-jvm/tree/main/needle).
268+
There is no documentation yet, but the code is on [GitHub](https://github.com/cucumber/cucumber-jvm/tree/main/cucumber-needle).
269269
{{% /block %}}
270270

271271
{{% block "ruby,javascript" %}} Needle is a Dependency Injection framework for JVM languages. {{% /block %}}
@@ -441,7 +441,7 @@ cucumber.object-factory=com.example.app.CustomObjectFactory
441441
### Using the Cucumber object factory with a test runner (JUnit 5/JUnit 4/TestNG)
442442
{{% block "java,kotlin" %}}
443443
The Cucumber modules for [JUnit 4](/docs/cucumber/api/#junit) and [TestNG](/docs/cucumber/checking-assertions/#testng) allow to run Cucumber through a JUnit/TestNG test.
444-
The custom object factory can be configured using the `@CucumberOptions` annotation. For JUnit 5 see the [cucumber-junit-platform-engine](https://github.com/cucumber/cucumber-jvm/tree/main/junit-platform-engine) documentation.
444+
The custom object factory can be configured using the `@CucumberOptions` annotation. For JUnit 5 see the [cucumber-junit-platform-engine](https://github.com/cucumber/cucumber-jvm/tree/main/cucumber-junit-platform-engine) documentation.
445445
{{% /block %}}
446446

447447
{{% block "ruby,javascript" %}} Using the Cucumber object factory is specific to JVM languages. {{% /block %}}
@@ -489,7 +489,7 @@ Feature: Let's write a lot of stuff to the DB
489489

490490
### With JUnit 5 and Spring
491491
{{% block "java,kotlin" %}}
492-
See the [`spring-txn`](https://github.com/cucumber/cucumber-jvm/tree/main/examples/spring-java-junit5) example in Cucumber-JVM for a minimal setup.
492+
See the [`spring-java-junit5`](https://github.com/cucumber/cucumber-jvm/tree/main/examples/spring-java-junit5) example in Cucumber-JVM for a minimal setup.
493493
{{% /block %}}
494494

495495
{{% block "ruby,javascript" %}} JUnit 5 and Spring are used with JVM languages. {{% /block %}}

content/docs/guides/parallel-execution.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ For each of these options, this tutorial will look at the project setup, configu
2323

2424
Cucumber Scenarios can be executed in parallel using the **JUnit Platform**.
2525

26-
See the [cucumber-junit-platform-engine documentation](https://github.com/cucumber/cucumber-jvm/tree/main/junit-platform-engine) for details.
26+
See the [cucumber-junit-platform-engine documentation](https://github.com/cucumber/cucumber-jvm/tree/main/cucumber-junit-platform-engine) for details.
2727
{{% /block %}}
2828

2929
# JUnit 4
@@ -302,7 +302,7 @@ If you have **multiple runners**, set the parallel configuration to `classes` to
302302
# CLI
303303

304304
{{% block "java,kotlin" %}}
305-
The `Main class` in the `io.cucumber.core.cli package` is used to execute the feature files. You can run this class directly from the command line; in that case, there is no need to create any runner class. The usage options for this class are mentioned [here](https://github.com/cucumber/cucumber-jvm/blob/v4.0.0/core/src/main/resources/cucumber/api/cli/USAGE.txt). The `--threads` option needs to be set to a value **greater than 1** to run in parallel. When the parallel mode is used, the scenarios and rows in a scenario outline will be run in multiple threads.
305+
The `Main` class in the `io.cucumber.core.cli` package is used to execute the feature files. You can run this class directly from the command line; in that case, there is no need to create any runner class. The usage options for this class are mentioned [here](https://github.com/cucumber/cucumber-jvm/blob/main/cucumber-core/src/main/resources/io/cucumber/core/options/USAGE.txt). The `--threads` option needs to be set to a value **greater than 1** to run in parallel. When the parallel mode is used, the scenarios and rows in a scenario outline will be run in multiple threads.
306306

307307
Follow the steps below to **execute the command from a terminal**.
308308

content/docs/installation/java.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ You can now run Cucumber [from the command line](/docs/cucumber/api/#from-the-co
106106

107107
# JUnit 5 integration
108108

109-
It is also possible to use [cucumber-junit-platform-engine](https://github.com/cucumber/cucumber-jvm/tree/main/junit-platform-engine) to run your Cucumber test suite.
109+
It is also possible to use [cucumber-junit-platform-engine](https://github.com/cucumber/cucumber-jvm/tree/main/cucumber-junit-platform-engine) to run your Cucumber test suite.
110110

111111
# JUnit 4 integration
112112

content/docs/installation/kotlin.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@ weight: 1145
88

99
There is no native Kotlin implementation of Cucumber, but you can use [Cucumber-JVM](/docs/installation/java) to write Cucumber tests in Kotlin.
1010

11-
For examples, please see the [kotlin-java8](https://github.com/cucumber/cucumber-jvm/tree/main/kotlin-java8) examples on GitHub.
11+
For examples, please see the [kotlin-java8](https://github.com/cucumber/cucumber-jvm/tree/main/cucumber-kotlin-java8) examples on GitHub.
1212

1313
To get started, have a look at this [blog](https://medium.com/@mlvandijk/kukumber-getting-started-with-cucumber-in-kotlin-e55112e7309b).

content/docs/installation/scala.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ libraryDependencies += "io.cucumber" %% "cucumber-scala" % "{{% version "cucumbe
3333
```
3434
# JUnit 5 integration
3535

36-
It is also possible to use [cucumber-junit-platform-engine](https://github.com/cucumber/cucumber-jvm/tree/main/junit-platform-engine) to run your Cucumber test suite.
36+
It is also possible to use [cucumber-junit-platform-engine](https://github.com/cucumber/cucumber-jvm/tree/main/cucumber-junit-platform-engine) to run your Cucumber test suite.
3737

3838
# JUnit 4 integration
3939

data/versions.yaml

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
# They can be referred to with the custom Hugo shortcode, e.g. {{% version "cucumberjvm" %}}
44
#
55

6-
cucumberjvm: "7.0.0"
6+
cucumberjvm: "7.5.0"
77
cucumberscala: "6.10.4"
88
cucumberjs: "7.3.1"
99
cucumberruby: "7.1.0"
1010
rspec: "3.10.0"
11-
testng: "7.4.0"
12-
junit: "5.8.1"
11+
testng: "7.6.1"
12+
junit: "5.9.0"

0 commit comments

Comments
 (0)