1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.net.URI
import org.nosphere.apache.rat.RatTask
buildscript { repositories { maven { url = java.net.URI("https://plugins.gradle.org/m2/") } } }
plugins {
id("idea")
id("eclipse")
id("polaris-root")
alias(libs.plugins.rat)
alias(libs.plugins.jetbrains.changelog)
}
val projectName = rootProject.file("ide-name.txt").readText().trim()
val ideName = "$projectName ${rootProject.version.toString().replace("^([0-9.]+).*", "\\1")}"
if (System.getProperty("idea.sync.active").toBoolean()) {
// There's no proper way to set the name of the IDEA project (when "just importing" or
// syncing the Gradle project)
val ideaDir = rootProject.layout.projectDirectory.dir(".idea")
ideaDir.asFile.mkdirs()
ideaDir.file(".name").asFile.writeText(ideName)
val icon = ideaDir.file("icon.png").asFile
if (!icon.exists()) {
copy {
from("site/static/img/logos/polaris-brandmark.png")
into(ideaDir)
rename { _ -> "icon.png" }
}
}
}
eclipse { project { name = ideName } }
tasks.named<RatTask>("rat").configure {
// Gradle
excludes.add("**/build/**")
excludes.add("gradle/wrapper/gradle-wrapper*")
excludes.add(".gradle")
excludes.add("**/kotlin-compiler*")
excludes.add("**/build-logic/.kotlin/**")
excludes.add("ide-name.txt")
excludes.add("version.txt")
excludes.add("DISCLAIMER_WIP")
excludes.add("LICENSE")
excludes.add("NOTICE")
// Files copied from Docsy (ASLv2 licensed) don't have header
excludes.add("site/layouts/docs/baseof.html")
excludes.add("site/layouts/shortcodes/redoc-polaris.html")
excludes.add("site/layouts/community/list.html")
excludes.add("site/layouts/partials/navbar.html")
excludes.add("site/layouts/partials/head.html")
excludes.add("site/layouts/partials/community_links.html")
excludes.add("layouts/partials/head.html")
// Hugo render hook - HTML comments would appear in rendered output
excludes.add("site/layouts/_default/_markup/render-heading.html")
// Files copied from OpenAPI Generator (ASLv2 licensed) don't have header
excludes.add("server-templates/*.mustache")
// Manifest files do not allow comments
excludes.add("tools/version/src/jarTest/resources/META-INF/FAKE_MANIFEST.MF")
// Git & GitHub
excludes.add(".git")
excludes.add(".github/pull_request_template.md")
// Misc build artifacts
excludes.add(".java-version")
excludes.add("**/.keep")
excludes.add("logs/**")
excludes.add("**/*.lock")
// Binary files
excludes.add(
"persistence/nosql/persistence/index/src/testFixtures/resources/org/apache/polaris/persistence/indexes/words.gz"
)
// Polaris service startup banner
excludes.add("runtime/service/src/**/banner.txt")
// Web site
excludes.add("**/go.sum")
excludes.add("site/.user-settings")
excludes.add("site/node_modules/**")
excludes.add("site/layouts/robots.txt")
// Ignore generated stuff, when the Hugo is run w/o Docker
excludes.add("site/public/**")
excludes.add("site/resources/_gen/**")
excludes.add("node_modules/**")
// Python
excludes.add("**/.venv/**")
excludes.add("**/polaris-venv/**")
excludes.add("**/uv.lock")
excludes.add("**/.ruff_cache/**")
excludes.add("**/.mypy_cache/**")
excludes.add("**/.pytest_cache/**")
excludes.add("client/python/.openapi-generator/**")
// Jupyter
excludes.add("**/*.ipynb")
// regtests
excludes.add("regtests/**/py.typed")
excludes.add("regtests/**/*.ref")
excludes.add("regtests/.env")
excludes.add("regtests/derby.log")
excludes.add("regtests/metastore_db/**")
excludes.add("regtests/output/**")
excludes.add("plugins/**/*.ref")
// IntelliJ
excludes.add(".idea")
excludes.add("**/*.iml")
excludes.add("**/*.iws")
// Rat can't scan binary images
excludes.add("**/*.png")
}
tasks.register<Exec>("buildPythonClient") {
group = "build"
description = "Build the python client"
workingDir = project.projectDir
if (project.hasProperty("python.format")) {
environment("FORMAT", project.property("python.format") as String)
}
commandLine("make", "client-build")
}
// Pass environment variables:
// ORG_GRADLE_PROJECT_apacheUsername
// ORG_GRADLE_PROJECT_apachePassword
// OR in ~/.gradle/gradle.properties set
// apacheUsername
// apachePassword
// Call targets:
// publishToApache
// closeApacheStagingRepository
// releaseApacheStagingRepository
// or closeAndReleaseApacheStagingRepository
//
// Username is your ASF ID
// Password: your ASF LDAP password - or better: a token generated via
// https://repository.apache.org/
nexusPublishing {
transitionCheckOptions {
// default==60 (10 minutes), wait up to 120 minutes
maxRetries = 720
// default 10s
delayBetween = java.time.Duration.ofSeconds(10)
}
repositories {
register("apache") {
nexusUrl = URI.create("https://repository.apache.org/service/local/")
snapshotRepositoryUrl =
URI.create("https://repository.apache.org/content/repositories/snapshots/")
}
}
}
copiedCodeChecks {
addDefaultContentTypes()
licenseFile = project.layout.projectDirectory.file("LICENSE")
scanDirectories {
register("build-logic") { srcDir("build-logic/src") }
register("misc") {
srcDir(".github")
srcDir("codestyle")
srcDir("getting-started")
srcDir("k8")
srcDir("regtests")
srcDir("server-templates")
srcDir("spec")
}
register("gradle") {
srcDir("gradle")
exclude("wrapper/*.jar")
exclude("wrapper/*.sha256")
}
register("site") {
srcDir("site")
exclude("build/**")
exclude(".hugo_build.lock")
}
register("root") {
srcDir(".")
include("*")
}
}
}
changelog {
repositoryUrl.set("https://github.com/apache/polaris")
title.set("Apache Polaris Changelog")
versionPrefix.set("apache-polaris-")
header.set(provider { "${version.get()}" })
groups.set(
listOf(
"Highlights",
"Upgrade notes",
"Breaking changes",
"New Features",
"Changes",
"Deprecations",
"Fixes",
"Commits",
)
)
version.set(provider { project.version.toString() })
}
tasks.register("showVersion") {
group = "application"
description = "Show the Polaris version"
actions.add {
logger.lifecycle(
"Polaris version is ${project.file("version.txt").readText(Charsets.UTF_8).trim()}"
)
}
}