Skip to content

Commit 12a35eb

Browse files
authored
Update release notes regarding removal of Ant code and potential replacements (#2153)
1 parent 630cedd commit 12a35eb

File tree

3 files changed

+20
-10
lines changed

3 files changed

+20
-10
lines changed

docs/getting_started.adoc

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ So why not run https://groovyconsole.dev/?g=groovy_4_0&codez=eNpdizEKg0AQRfs9xU8
1111

1212
== Spock Example Project
1313

14-
To try Spock in your local environment, clone or download/unzip the
15-
https://github.com/spockframework/spock-example[Spock Example Project]. It comes with fully working Ant, Gradle, and
16-
Maven builds that require no further setup. The Gradle build even bootstraps Gradle itself and gets you up and
17-
running in Eclipse or IDEA with a single command. See the README for detailed instructions.
14+
To try Spock in your local environment, clone or download/unzip the {spock-example-project}[Spock Example Project].
15+
It comes with fully working Ant, Gradle, and Maven builds that require no further setup. The Gradle build even bootstraps
16+
Gradle itself and gets you up and running in Eclipse or IDEA with a single command. See the README for detailed instructions.

docs/include.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,3 +34,5 @@
3434
:base-sourcedir-spring-boot: spock-spring/boot2-test/src/test/groovy/org/spockframework/boot2
3535
:sourcedir-spring-boot: ../{base-sourcedir-spring-boot}
3636
:github-sourcedir-spring-boot: {github-blob-base}/{commit-ish}/{base-sourcedir-spring-boot}
37+
// Common Includes
38+
:spock-example-project: https://github.com/spockframework/spock-example

docs/release_notes.adoc

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
[[release-notes]]
22
= Release Notes
3-
43
include::include.adoc[]
4+
:SpecClassFileSelector: https://github.com/spockframework/spock/blob/03818ed010f4b4ca1136a292e214f79d518c4abe/spock-core/src/main/java/org/spockframework/buildsupport/ant/SpecClassFileSelector.java
5+
:scriptselector: {spock-example-project}/blob/963fd34d1609b7025ba92502483ce31b2c6d9d0a/build.xml#L167-L176
56

67
== 2.4 (tbd)
78

@@ -671,9 +672,17 @@ It can be set back to the old pre Spock 2.0 behaviour by setting
671672
will be thrown at runtime.
672673

673674
// tag::breaking-change-removed-ant-support[]
674-
==== Ant support removed
675-
`SpecClassFileSelector` was removed, which was the only class that required `ant`.
676-
If you are still using spock with `ant`, then you can just copy the class from the spock source code into your build.
675+
==== Ant custom selector removed
676+
The class `SpecClassFileSelector` that could be used to only select actual Spock specification classes when testing
677+
and creating a test report was removed. It was the only class that required `ant` and was basically just a one-line
678+
forward to the `SpecClassFileFinder` which is still available.
679+
680+
If you are still using Spock with `ant`, then you can just copy {SpecClassFileSelector}[the class from the spock source code]
681+
into your build, or you simply use a {scriptselector}[`<scriptselector>`] that does this forwarding as shown in the
682+
{spock-example-project}[Spock Example Project].
683+
684+
Alternatively, you can also use a naming convention to find the classes that are actual specifications and not helper
685+
or base classes, or you live with a bit of wasted time and some meaningless entries in the test reports.
677686
// end::breaking-change-removed-ant-support[]
678687

679688
=== Misc
@@ -1229,7 +1238,7 @@ Howard M. Lewis Ship, Ken Sipe, Venkat Subramaniam, Russel Winder.
12291238
* Improved and restyled reference documentation at https://docs.spockframework.org. Generated with
12301239
https://asciidoctor.org/[Asciidoctor] (what else?).
12311240
* Maven plugin removed. Just let Maven Surefire run your Spock specs like your JUnit tests
1232-
(see https://examples.spockframework.org[spock-example] project).
1241+
(see {spock-example-project}[spock-example] project).
12331242
* Official support for Java 1.8, Groovy 2.3 and Groovy 2.4. Make sure to pick the `groovy-2.0` binaries for Groovy
12341243
2.0/2.1/2.2, `groovy-2.3` binaries for Groovy 2.3, and `groovy-2.4` binaries for Groovy 2.4 and higher.
12351244
* Improved infrastructure to allow for easier community involvement: Switch to
@@ -1787,7 +1796,7 @@ their types inferred from the values in the table (!).
17871796
=== GitHub Repository
17881797

17891798
All source code has moved to https://github.spockframework.org/. The https://github.spockframework.org/spock-grails[Grails Spock plugin],
1790-
https://github.spockframework.org/spock-example[Spock Example] project, and
1799+
{spock-example-project}[Spock Example] project, and
17911800
https://github.spockframework.org/spockwebconsole[Spock Web Console] now have their own GitHub projects.
17921801
Also available are slides and code for various Spock presentations (such as
17931802
https://github.spockframework.org/smarter-testing-with-spock[this one]).

0 commit comments

Comments
 (0)