Skip to content

Commit 89b7736

Browse files
author
ADMSK\AVROGAL1
committed
docs: updates on documentation
Added informational and corporate documentation
1 parent 721b6cc commit 89b7736

File tree

9 files changed

+110
-8
lines changed

9 files changed

+110
-8
lines changed

.github/dco.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Disable sign-off chcecking for members of the Gradle GitHub organization
2+
require:
3+
members: false

.github/release-drafter.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name-template: $NEXT_MINOR_VERSION
2+
tag-template: v$NEXT_MINOR_VERSION
3+
4+
categories:
5+
- title: 🚀 New features and improvements
6+
labels:
7+
- enhancement
8+
- title: 🐛 Bug Fixes
9+
labels:
10+
- bug
11+
- title: 🚦 Internal changes
12+
labels:
13+
- internal
14+
15+
exclude-labels:
16+
- no-changelog
17+
- duplicate
18+
- invalid
19+
20+
template: |
21+
$CHANGES

.github/workflows/ci.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,13 @@ jobs:
4040
- name: Prepare repository
4141
run: git fetch --unshallow --tags
4242

43+
- name: Branch name
44+
id: branch_name
45+
run: |
46+
echo ::set-output name=SOURCE_NAME::${GITHUB_REF#refs/*/}
47+
echo ::set-output name=SOURCE_BRANCH::${GITHUB_REF#refs/heads/}
48+
echo ::set-output name=SOURCE_TAG::${GITHUB_REF#refs/tags/}
49+
4350
- name: Make checksum executable
4451
run: chmod +x ./scripts/checksum.sh
4552

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
name: Enforce PR labels for release drafter
2+
3+
on:
4+
pull_request:
5+
types: [ labeled, unlabeled, opened, edited, synchronize ]
6+
jobs:
7+
enforce-label:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- uses: yogevbd/[email protected]
11+
with:
12+
REQUIRED_LABELS_ANY: "bug,enhancement,internal,no-changelog"
13+
REQUIRED_LABELS_ANY_DESCRIPTION: "Select at least one label ['bug','enhancement','internal','no-changelog'] for the PR"

buildSrc/src/main/groovy/bintray.gradle

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ task javadocsJar(type: Jar, dependsOn: rootProject.dokka) {
1717
}
1818

1919
artifacts {
20+
archives jar
2021
archives javadocsJar
2122
archives sourcesJar
2223
}

buildSrc/src/main/groovy/publication.gradle

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,21 @@ task javadoc(type: Javadoc) {
7878
options.addStringOption('Xdoclint:all,-html', '-quiet')
7979
}
8080

81+
task mergedJavadoc(type: Javadoc, description: 'Creates Javadoc from all the projects.') {
82+
title = 'All modules'
83+
destinationDir = new File(project.buildDir, 'merged-javadoc')
84+
85+
// Note: The closures below are executed lazily.
86+
source {
87+
subprojects*.sourceSets*.main*.allSource
88+
}
89+
classpath.from {
90+
subprojects*.configurations*.compile*.copyRecursive({ !(it instanceof ProjectDependency); })*.resolve()
91+
}
92+
}
93+
8194
artifacts {
95+
archives jar
8296
archives sourcesJar
8397
archives javadocJar
8498
}

buildSrc/src/main/groovy/subproject.gradle

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,8 @@ def useModules = jvmVersion >= 9 && !project.hasProperty('no-modules')
3535
compileJava {
3636
if (useModules) {
3737
doFirst {
38+
options.fork = true
39+
//options.forkOptions.executable = "${System.getenv("JAVA_HOME")}/bin/javac"
3840
options.compilerArgs += [
3941
'--module-path', classpath.asPath,
4042
]
@@ -65,6 +67,9 @@ tasks.withType(Test) {
6567
// Use JUnit 5 with Jupiter
6668
useJUnitPlatform()
6769

70+
// Always run tests, even when nothing changed.
71+
dependsOn 'cleanTest'
72+
6873
jvmArgs += ["-XX:MaxPermSize=512m"]
6974

7075
minHeapSize = "256m"
@@ -168,6 +173,15 @@ sourceSets {
168173
}
169174
}
170175

176+
task createFolders(description: 'Creates the source folders if they do not exist.') doLast {
177+
sourceSets*.allSource*.srcDirs*.each { File srcDir ->
178+
if (!srcDir.isDirectory()) {
179+
println "Creating source folder: ${srcDir}"
180+
srcDir.mkdirs()
181+
}
182+
}
183+
}
184+
171185
task functionalTest(type: Test) {
172186
testClassesDirs = sourceSets.functionalTest.output.classesDirs
173187
classpath = sourceSets.functionalTest.runtimeClasspath

protobuf/build.gradle

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,5 +77,8 @@ compileTestJava {
7777
}
7878

7979
javadoc {
80+
options.addStringOption('Xdoclint:all,-missing', '-quiet')
8081
options.encoding = 'UTF-8'
82+
//executable = "${System.getenv("JAVA_HOME")}/bin/javadoc"
83+
failOnError true
8184
}

settings.gradle

Lines changed: 34 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ pluginManagement {
2525
// build scan plugin can only be applied in settings file
2626
plugins {
2727
id('com.gradle.enterprise') version '3.5.2'
28+
id("com.gradle.enterprise.gradle-enterprise-conventions-plugin").version("0.7.2")
2829
}
2930

3031
gradleEnterprise {
@@ -37,11 +38,36 @@ gradleEnterprise {
3738

3839
rootProject.name = 'gradle-java-sample'
3940

40-
include 'appflow'
41-
include 'testflow'
42-
include 'protobuf'
43-
include 'flatbuffers'
44-
include 'avro'
45-
include 'thrift'
46-
include 'codecheck'
47-
include 'db-schema'
41+
// Find the directories containing a "build.gradle" file in the root directory
42+
// of the project. That is, every directory containing a "build.gradle" will
43+
// be automatically the subproject of this project.
44+
def subDirs = rootDir.listFiles(new FileFilter() {
45+
boolean accept(File file) {
46+
if (!file.isDirectory()) {
47+
return false
48+
}
49+
if (file.name == 'buildSrc') {
50+
return false
51+
}
52+
return new File(file, 'build.gradle').isFile()
53+
}
54+
})
55+
56+
subDirs.each { File dir ->
57+
if (dir.name.startsWith("gradle-")) {
58+
include dir.name
59+
}
60+
61+
include 'appflow'
62+
include 'testflow'
63+
include 'protobuf'
64+
include 'flatbuffers'
65+
include 'avro'
66+
include 'thrift'
67+
include 'codecheck'
68+
include 'db-schema'
69+
}
70+
71+
//rootProject.children.forEach {
72+
// it.projectDir = rootDir.resolve( "subprojects/${it.name}")
73+
//}

0 commit comments

Comments
 (0)