refactor(build): update build configurations (#195)

Move the Gradle documentation related configurations from the main `build.gradle` to a separate `gradle/docs.gradle` file for easy maintenance.
grails · Mar 19, 2024 · 338b337 · 338b337
1 parent f19e158
commit 338b337
Show file tree

Hide file tree

Showing 2 changed files with 66 additions and 48 deletions.
diff --git a/build.gradle b/build.gradle
@@ -20,6 +20,7 @@ apply plugin: 'groovy'
 apply plugin: "com.github.erdi.webdriver-binaries"
 apply plugin:"org.grails.grails-plugin"
 apply plugin:"org.grails.internal.grails-plugin-publish"
+apply from: 'gradle/docs.gradle'
 
 repositories {
  mavenCentral()
@@ -108,49 +109,6 @@ tasks.withType(Test) {
  }
 }
 
-task publishGuide(type: grails.doc.gradle.PublishGuide) {
- group = 'documentation'
- description = 'Generate Guide'
-
- targetDir = project.file("${buildDir}/docs")
- sourceRepo = "https://github.com/${githubSlug}/edit/${githubBranch}/src/main/docs"
- sourceDir = new File(projectDir, "src/main/docs")
- propertiesFiles = [ new File(rootProject.projectDir, "gradle.properties") ]
- asciidoc = true
- properties = [
- 'safe':'UNSAFE',
- 'version': project.version,
- 'subtitle': project.projectDesc,
- 'api': '../api',
- 'sourceDir':rootProject.projectDir.absolutePath,
- 'sourcedir':rootProject.projectDir.absolutePath,
- 'javaee': 'https://docs.oracle.com/javaee/7/api/',
- 'javase': 'https://docs.oracle.com/javase/7/docs/api/',
- 'groovyapi': 'https://docs.groovy-lang.org/latest/html/gapi/',
- 'grailsapi': 'https://docs.grails.org/latest/api/',
- 'gormapi': 'https://gorm.grails.org/latest/api/',
- 'springapi': 'https://docs.spring.io/spring/docs/current/javadoc-api/'
- ]
- doLast {
- ant.move(file:"${project.buildDir}/docs/guide/single.html",
- tofile:"${project.buildDir}/docs/guide/index.html", overwrite:true)
- new File(project.buildDir, "docs/index.html").text = '''
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http:https://www.w3.org/TR/html4/loose.dtd">
-<html lang="en">
-<head>
-<meta http-equiv="refresh" content="0; url=guide/index.html" />
-</head>
-
-</body>
-</html>
-'''
- }
-}
-
-task docs(dependsOn:[groovydoc, publishGuide]) {
- group = 'documentation'
-}
-
 bootRun {
  jvmArgs(
  '-Dspring.output.ansi.enabled=always',
@@ -187,8 +145,3 @@ jar {
  includeEmptyDirs = false
  exclude 'com/demo/**'
 }
-
-tasks.named("build") {
- finalizedBy("docs")
-}
-
diff --git a/gradle/docs.gradle b/gradle/docs.gradle
@@ -0,0 +1,65 @@
+buildscript {
+ repositories {
+ maven { url "https://repo.grails.org/grails/core" }
+ }
+ dependencies {
+ classpath "org.grails:grails-docs:${project.ext.properties.grailsDocsVersion ?: grailsVersion}"
+ }
+}
+
+repositories {
+ mavenCentral()
+ maven { url "https://repo.grails.org/grails/core" }
+}
+
+configurations {
+ documentation.extendsFrom(compileClasspath)
+}
+
+task publishGuide(type: grails.doc.gradle.PublishGuide) {
+ group = 'documentation'
+ description = 'Generate Guide'
+
+ targetDir = project.file("${buildDir}/docs")
+ sourceRepo = "https://github.com/${githubSlug}/edit/${githubBranch}/src/main/docs"
+ sourceDir = new File(projectDir, "src/main/docs")
+ resourcesDir = new File(projectDir, "src/main/docs/resources")
+ propertiesFiles = [ new File(rootProject.projectDir, "gradle.properties") ]
+ asciidoc = true
+ properties = [
+ 'safe':'UNSAFE',
+ 'version': project.version,
+ 'subtitle': project.projectDesc,
+ 'api': '../api',
+ 'sourceDir':rootProject.projectDir.absolutePath,
+ 'sourcedir':rootProject.projectDir.absolutePath,
+ 'javaee': 'https://docs.oracle.com/javaee/7/api/',
+ 'javase': 'https://docs.oracle.com/javase/7/docs/api/',
+ 'groovyapi': 'https://docs.groovy-lang.org/latest/html/gapi/',
+ 'grailsapi': 'https://docs.grails.org/latest/api/',
+ 'gormapi': 'https://gorm.grails.org/latest/api/',
+ 'springapi': 'https://docs.spring.io/spring/docs/current/javadoc-api/'
+ ]
+ doLast {
+ ant.move(file:"${project.buildDir}/docs/guide/single.html",
+ tofile:"${project.buildDir}/docs/guide/index.html", overwrite:true)
+ new File(project.buildDir, "docs/index.html").text = '''
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http:https://www.w3.org/TR/html4/loose.dtd">
+<html lang="en">
+<head>
+<meta http-equiv="refresh" content="0; url=guide/index.html" />
+</head>
+
+</body>
+</html>
+'''
+ }
+}
+
+task docs(dependsOn:[groovydoc, publishGuide]) {
+ group = 'documentation'
+}
+
+tasks.named("build") {
+ finalizedBy("docs")
+}