Skip to content

Commit 025a3e3

Browse files
rainboyanrainboyan
committed
Update documentation
- Update installation and usage - Add release notes and support
1 parent b4ad096 commit 025a3e3

File tree

8 files changed

+354
-8
lines changed

8 files changed

+354
-8
lines changed

‎docs/guide/installation.adoc‎

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,23 @@
1-
== Installation
2-
3-
To start using this library, there are only a couple simple steps:
1+
To start using this plugin, there are only a couple simple steps:
42

53
. Import the library in your `build.gradle`
64

7-
[source,groovy,subs="attributes",indent=1]
8-
testImplementation "org.graceframework.plugins:geb:{version}"
5+
[source,groovy,subs="attributes"]
6+
----
7+
dependencies {
8+
testImplementation "org.graceframework.plugins:geb:{version}"
9+
testImplementation "org.seleniumhq.selenium:selenium-api"
10+
testImplementation "org.seleniumhq.selenium:selenium-support"
11+
testRuntimeOnly "org.seleniumhq.selenium:selenium-chrome-driver"
12+
testRuntimeOnly "org.seleniumhq.selenium:selenium-firefox-driver"
13+
}
14+
----
15+
16+
Before 6.3, Geb plugin use https://github.com/erdi/webdriver-binaries-gradle-plugin[WebDriver binaries Gradle plugin] to downloads and caches WebDriver binaries specific to the OS the build runs on, but this plugin dosen't support Gradle 8.7+ due to https://github.com/erdi/webdriver-binaries-gradle-plugin/issues/43[this issue], so Geb plugin doesn't use it in 6.3 any more.
17+
18+
[quote]
19+
----
20+
Selenium Manager is a command-line tool implemented in Rust that provides automated driver and browser management for Selenium. Selenium bindings use this tool by default, so you do not need to download it or add anything to your code or do anything else to use it.
21+
----
22+
23+
We recommend you use https://www.selenium.dev/documentation/selenium_manager/[Selenium Manager] instead of WebDriver binaries Gradle plugin. In 6.3, Selenium dependencies have already been upgraded to 4.19.1, you can check the managed versions in the https://repo1.maven.org/maven2/org/springframework/boot/spring-boot-dependencies/3.3.13/spring-boot-dependencies-3.3.13.pom[Spring Boot Dependencies 3.3.13].

‎docs/guide/introduction.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@ Geb Functional Testing for Grace application
22

33
This plugin just provides the Geb dependencies and a `create-functional-test` command for generating Geb tests in a Grace app.
44

5-
For further reference please see the http://www.gebish.org[Geb documentation].
5+
For further reference please see the https://groovy.apache.org/geb/manual/current/[Geb documentation].

‎docs/guide/releases.adoc‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
[[releases]]
2+
== Release History
3+
4+
To make it easier for users to use and upgrade, Plugin adopts a version policy consistent with the https://github.com/graceframework/grace-framework[Grace Framework].
5+
6+
7+
[cols="1,1"]
8+
|===
9+
| Plugin Version
10+
| Grace Version
11+
12+
| 6.3.x
13+
| 2023.3.x
14+
| 6.2.x
15+
| 2023.2.x
16+
17+
| 6.1.x
18+
| 2023.1.x
19+
20+
| 6.0.x
21+
| 2023.0.x
22+
23+
| 5.2.x
24+
| 2022.2.x
25+
26+
| 5.1.x
27+
| 2022.1.x
28+
29+
| 5.0.x
30+
| 2022.0.x
31+
|===

‎docs/guide/releases/6.x.adoc‎

Lines changed: 263 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,263 @@
1+
=== 6.3.0
2+
3+
link:{github}/releases/tag/v6.3.0[release notes]
4+
5+
⭐️ New Features
6+
7+
* Setup github docs workflows
8+
* Use 'grace-doc' Gradle plugin to generate documentation link:{github}/issues/31[#31]
9+
10+
🛠 Improvements
11+
12+
* Add document to create-functional-test command link:{github}/issues/34[#34]
13+
* Add new flag `force` to create-functional-test command link:{github}/issues/33[#33]
14+
* Update FunctionalSpec - Use the url of Apache Geb manual - Update the default test link:{github}/issues/32[#32]
15+
* Update LICENSE
16+
* Update github workflows - Upgrade to setup-gradle@v4
17+
18+
🚀 Dependency Upgrades
19+
20+
* Update README Update badge versions of Grace, Groovy and Spring Boot
21+
* Upgrade to Grace 2023.3.0-RC1 link:{github}/issues/28[#28]
22+
* Upgrade to Grace 2023.3.0-RC2 link:{github}/issues/30[#30]
23+
* Upgrade to Gradle 8.14 link:{github}/issues/29[#29]
24+
25+
=== 6.3.0-RC1
26+
27+
link:{github}/releases/tag/v6.3.0-RC1[release notes]
28+
29+
🛠 Improvements
30+
31+
* Remove the unnecessary workaround for removing the generated extra dependencyManagement of POM link:{github}/issues/27[#27]
32+
33+
🚀 Dependency Upgrades
34+
35+
* Upgrade to Grace 2023.3.0-M2 link:{github}/issues/22[#22]
36+
* Upgrade to Gradle 8.13 link:{github}/issues/24[#24]
37+
* Upgrade to Groovy 4.0.26 link:{github}/issues/23[#23]
38+
* Upgrade to Jansi 2.4.1 link:{github}/issues/25[#25]
39+
* Upgrade to Java Parser 3.26.4 link:{github}/issues/26[#26]
40+
41+
⚙️ Tasks
42+
43+
* Release v6.3.0-RC1
44+
45+
=== 6.3.0-M1
46+
47+
link:{github}/releases/tag/v6.3.0-M1[release notes]
48+
49+
🛠 Improvements
50+
51+
* Update README Update badge versions of Grace and Spring Boot
52+
* Update github workflows Switch to 6.3.x branch
53+
54+
🚀 Dependency Upgrades
55+
56+
* Upgrade to Grace 2023.3.0-M1 link:{github}/issues/21[#21]
57+
58+
⚙️ Tasks
59+
60+
* Release v6.3.0-M1
61+
* Set version to 6.3.0-SNAPSHOT
62+
63+
=== 6.2.0
64+
65+
link:{github}/releases/tag/v6.2.0[release notes]
66+
67+
🛠 Improvements
68+
69+
* Update README
70+
* Add GitHub issue template link:{github}/issues/19[#19]
71+
* Update build scripts to avoid deprecation warnings with Gradle 8 link:{github}/issues/18[#18]
72+
73+
🚀 Dependency Upgrades
74+
75+
* Upgrade to Grace 2023.2.0-RC1 link:{github}/issues/17[#17]
76+
77+
⚙️ Tasks
78+
79+
* Release v6.2.0
80+
81+
=== 6.2.0-RC1
82+
83+
link:{github}/releases/tag/v6.2.0-RC1[release notes]
84+
85+
🚀 Dependency Upgrades
86+
87+
* Upgrade to Grace 2023.2.0-M3 link:{github}/issues/15[#15]
88+
* Upgrade to Grace 2023.2.0-M2 link:{github}/issues/14[#14]
89+
* Upgrade to Gradle 8.12 link:{github}/issues/16[#16]
90+
91+
⚙️ Tasks
92+
93+
* Release v6.2.0-RC1
94+
95+
=== 6.2.0-M1
96+
97+
link:{github}/releases/tag/v6.2.0-M1[release notes]
98+
99+
🛠 Improvements
100+
101+
* Update README Update badge of Grace to current version
102+
* Update github workflows Switch to 6.2.x branch
103+
104+
🚀 Dependency Upgrades
105+
106+
* Upgrade to Grace 2023.2.0-M1 link:{github}/issues/13[#13]
107+
108+
⚙️ Tasks
109+
110+
* Release v6.2.0-M1
111+
* Set version to 6.2.0-SNAPSHOT
112+
113+
=== 6.1.0
114+
115+
link:{github}/releases/tag/v6.1.0[release notes]
116+
117+
🛠 Improvements
118+
119+
* Update Badges
120+
121+
🚀 Dependency Upgrades
122+
123+
* Upgrade to Grace 2023.1.0-RC1 link:{github}/issues/10[#10]
124+
* Upgrade to Groovy 4.0.24 link:{github}/issues/11[#11]
125+
126+
⚙️ Tasks
127+
128+
* Release v6.1.0
129+
130+
=== 6.1.0-RC1
131+
132+
link:{github}/releases/tag/v6.1.0-RC1[release notes]
133+
134+
🛠 Improvements
135+
136+
* Use Java 17 toolchain link:{github}/issues/9[#9]
137+
* Use `classesDirectory` property instead of deprecated `outputDir` link:{github}/issues/8[#8]
138+
* Using repository gradlePluginPortal() link:{github}/issues/6[#6]
139+
140+
🚀 Dependency Upgrades
141+
142+
* Upgrade to Grace 2023.1.0-M3 link:{github}/issues/5[#5]
143+
* Upgrade to Gradle Nexus Publish Plugin 2.0.0 link:{github}/issues/7[#7]
144+
145+
⚙️ Tasks
146+
147+
* Release v6.1.0-RC1
148+
149+
=== 6.1.0-M3
150+
151+
link:{github}/releases/tag/v6.1.0-M3[release notes]
152+
153+
🛠 Improvements
154+
155+
* Remove dependencyManagement node of the generated POM file link:{github}/issues/4[#4]
156+
157+
🚀 Dependency Upgrades
158+
159+
* Upgrade to Grace 2023.1.0-M2 link:{github}/issues/3[#3]
160+
161+
⚙️ Tasks
162+
163+
* Release v6.1.0-M3
164+
165+
=== 6.1.0-M2
166+
167+
link:{github}/releases/tag/v6.1.0-M2[release notes]
168+
169+
🛠 Improvements
170+
171+
* Make dependency `grace-core` compileOnly link:{github}/issues/2[#2]
172+
* Update README
173+
174+
🚀 Dependency Upgrades
175+
176+
* Upgrade to Grace 2023.1.0-M1 link:{github}/issues/1[#1]
177+
178+
⚙️ Tasks
179+
180+
* Release v6.1.0-M2
181+
182+
=== 6.1.0-M1
183+
184+
link:{github}/releases/tag/v6.1.0-M1[release notes]
185+
186+
🐞 Bug Fixes
187+
188+
* Remove `@PluginSource` on `GebGrailsPlugin`
189+
190+
🛠 Improvements
191+
192+
* Update README
193+
* Update README
194+
* Update README
195+
196+
🚀 Dependency Upgrades
197+
198+
* Upgrade to Groovy 4.0.23
199+
* Upgrade to Grace 2023.0.2
200+
201+
⚙️ Tasks
202+
203+
* Release v6.1.0-M1
204+
* Update github workflows
205+
* Set version to 6.1.0-SNAPSHOT
206+
207+
=== 6.0.1
208+
209+
link:{github}/releases/tag/v6.0.1[release notes]
210+
211+
* Release v6.0.1
212+
* Upgrade to Grace 2023.0.0
213+
* Set version to 6.0.1-SNAPSHOT
214+
215+
=== 6.0.0
216+
217+
link:{github}/releases/tag/v6.0.0[release notes]
218+
219+
* Release v6.0.0
220+
* Upgrade to Groovy 4.0.22
221+
* Upgrade to Grace 2023.0.0-RC2
222+
223+
=== 6.0.0-RC1
224+
225+
link:{github}/releases/tag/v6.0.0-RC1[release notes]
226+
227+
* Release v6.0.0-RC1
228+
* Upgrade to Gradle Wrapper 7.6.4
229+
* Upgrade to Groovy 4.0.21
230+
* Upgrade to Grace 2023.0.0-M7
231+
232+
=== 6.0.0-M3
233+
234+
link:{github}/releases/tag/v6.0.0-M3[release notes]
235+
236+
* Release v6.0.0-M3
237+
* Set `archiveClassifier` with 'plugin'
238+
* Update plugin: set grailsVersion
239+
* Update build.gradle
240+
* Upgrade to Grace 2023.0.0-M6
241+
242+
=== 6.0.0-M2
243+
244+
link:{github}/releases/tag/v6.0.0-M2[release notes]
245+
246+
* Release v6.0.0-M2
247+
* Update README
248+
* Upgrade to Grace 2023.0.0-M5
249+
* Grace: update github workflows
250+
* Back to 6.0.0-SNAPSHOT
251+
252+
=== 6.0.0-M1
253+
254+
link:{github}/releases/tag/v6.0.0-M1[release notes]
255+
256+
* Release v6.0.0-M1
257+
* Grace: update github workflows
258+
* Grace: migrate to app dir
259+
* Grace: update plugin info
260+
* Grace: Update scripts and templates
261+
* Upgrade to Grace 2023.0.0-M2
262+
* Grace: update gradle build scripts
263+
* Bump version: 6.0.0-SNAPSHOT

‎docs/guide/support.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
For support, please use the https://github.com/orgs/graceframework/discussions[Grace Discussions] or open an issue on link:{github}/issues[Github Issues].

‎docs/guide/toc.yml‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
11
introduction: Introduction
2+
releases:
3+
title: Release History
4+
6.x: What's new in 6.x
25
installation: Installation
3-
usage: Usage
6+
usage: Usage
7+
support: Support

‎docs/guide/usage.adoc‎

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,32 @@
1-
== Usage
1+
Grace Geb plugin provides a Grace Script Command link:../ref/Commands/create-functional-test.html[create-functional-test] to create Geb functional test for your application.
2+
3+
[source,console]
4+
----
5+
$ grace create-functional-test Post
6+
| Created src/integration-test/groovy/com/example/PostSpec.groovy
7+
----
8+
9+
_.src/integration-test/groovy/com/example/PostSpec.groovy_
10+
[source,groovy]
11+
----
12+
@Integration
13+
@Rollback
14+
class PostSpec extends GebSpec {
15+
16+
def setup() {
17+
}
18+
19+
def cleanup() {
20+
}
21+
22+
void "test the homepage title"() {
23+
when: "The homepage is visited"
24+
go '/'
25+
26+
then: "The title is correct"
27+
title == "Welcome to Grace"
28+
}
29+
}
30+
----
31+
32+
you can check https://groovy.apache.org/geb/manual/7.0/[The Book Of Geb] to learn how to write the Geb functional tests.

‎docs/resources/doc.properties‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
api=../api
22
guide=../../guide
33
tags=../ref/Tags
4+
github=https://github.com/graceframework/grace-geb
45
sourcedir=.
56
sourceRepo=https://github.com/graceframework/grace-geb/edit/6.3.x/docs
67
safe=UNSAFE

0 commit comments

Comments
 (0)