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
|
<!--
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.
-->
# Developer Scripts
This folder contains various useful scripts for developers, mostly related to
releasing new versions of Lucene and testing those.
Python scripts require Python 3.6 or avobe. To install necessary python modules, please run:
pip3 install -r requirements.txt
## Scripts description
### smokeTestRelease.py
Used to validate new release candidates (RC). The script downloads an RC from a URL
or local folder, then runs a number of sanity checks on the artifacts, and then runs
the full tests.
usage: smokeTestRelease.py [-h] [--tmp-dir PATH] [--not-signed]
[--local-keys PATH] [--revision REVISION]
[--version X.Y.Z(-ALPHA|-BETA)?]
[--test-java12 JAVA12_HOME] [--download-only]
url ...
Utility to test a release.
positional arguments:
url Url pointing to release to test
test_args Arguments to pass to ant for testing, e.g.
-Dwhat=ever.
optional arguments:
-h, --help show this help message and exit
--tmp-dir PATH Temporary directory to test inside, defaults to
/tmp/smoke_lucene_$version_$revision
--not-signed Indicates the release is not signed
--local-keys PATH Uses local KEYS file instead of fetching from
https://archive.apache.org/dist/lucene/KEYS
--revision REVISION GIT revision number that release was built with,
defaults to that in URL
--version X.Y.Z(-ALPHA|-BETA)?
Version of the release, defaults to that in URL
--test-java12 JAVA12_HOME
Path to Java12 home directory, to run tests with if
specified
--download-only Only perform download and sha hash check steps
Example usage:
python3 -u dev-tools/scripts/smokeTestRelease.py https://dist.apache.org/repos/dist/dev/lucene/lucene-9.0.1-RC2-revc7510a0...
### releaseWizard.py
The Release Wizard guides the Release Manager through the release process step
by step, helping you to to run the right commands in the right order, generating
e-mail templates with the correct texts, versions, paths etc, obeying
the voting rules and much more. It also serves as a documentation of all the
steps, with timestamps, preserving log files from each command etc, showing only
the steps and commands required for a major/minor/bugfix release. It also lets
you generate a full Asciidoc guide for the release. The wizard will execute many
of the other tools in this folder.
usage: releaseWizard.py [-h] [--dry-run] [--init]
Script to guide a RM through the whole release process
optional arguments:
-h, --help show this help message and exit
--dry-run Do not execute any commands, but echo them instead. Display
extra debug info
--init Re-initialize root and version
Go push that release!
### buildAndPushRelease.py
usage: buildAndPushRelease.py [-h] [--no-prepare] [--local-keys PATH]
[--push-local PATH] [--sign KEYID]
[--rc-num NUM] [--root PATH] [--logfile PATH]
Utility to build, push, and test a release.
optional arguments:
-h, --help show this help message and exit
--no-prepare Use the already built release in the provided checkout
--local-keys PATH Uses local KEYS file to validate presence of RM's gpg key
--push-local PATH Push the release to the local path
--sign KEYID Sign the release with the given gpg key
--rc-num NUM Release Candidate number. Default: 1
--root PATH Root of Git working tree for lucene. Default: "."
(the current directory)
--logfile PATH Specify log file path (default /tmp/release.log)
Example usage for a Release Manager:
python3 -u dev-tools/scripts/buildAndPushRelease.py --push-local /tmp/releases/6.0.1 --sign 6E68DA61 --rc-num 1
### addBackcompatIndexes.py
usage: addBackcompatIndexes.py [-h] [--force] [--no-cleanup] [--temp-dir DIR]
version
Add backcompat index and test for new version. See:
http://wiki.apache.org/lucene-java/ReleaseTodo#Generate_Backcompat_Indexes
positional arguments:
version Version to add, of the form X.Y.Z
optional arguments:
-h, --help show this help message and exit
--force Redownload the version and rebuild, even if it already
exists
--no-cleanup Do not cleanup the built indexes, so that they can be reused
for adding to another branch
--temp-dir DIR Temp directory to build backcompat indexes within
### addVersion.py
usage: addVersion.py [-h] version
Add a new version to CHANGES, to Version.java and build.gradle files
positional arguments:
version
optional arguments:
-h, --help show this help message and exit
### releasedJirasRegex.py
Pulls out all JIRAs mentioned at the beginning of bullet items
under the given version in the given CHANGES.txt file
and prints a regular expression that will match all of them
usage: releasedJirasRegex.py [-h] version changes
Prints a regex matching JIRAs fixed in the given version by parsing the given
CHANGES.txt file
positional arguments:
version Version of the form X.Y.Z
changes CHANGES.txt file to parse
optional arguments:
-h, --help show this help message and exit
### reproduceJenkinsFailures.py
usage: reproduceJenkinsFailures.py [-h] [--no-git] [--iters N] URL
Must be run from a Lucene git workspace. Downloads the Jenkins
log pointed to by the given URL, parses it for Git revision and failed
Lucene tests, checks out the Git revision in the local workspace,
groups the failed tests by module, then runs
'ant test -Dtest.dups=%d -Dtests.class="*.test1[|*.test2[...]]" ...'
in each module of interest, failing at the end if any of the runs fails.
To control the maximum number of concurrent JVMs used for each module's
test run, set 'tests.jvms', e.g. in ~/lucene.build.properties
positional arguments:
URL Points to the Jenkins log to parse
optional arguments:
-h, --help show this help message and exit
--no-git Do not run "git" at all
--iters N Number of iterations per test suite (default: 5)
### githubPRs.py
usage: githubPRs.py [-h] [--json] [--token TOKEN]
Find open Pull Requests that need attention
optional arguments:
-h, --help show this help message and exit
--json Output as json
--token TOKEN Github access token in case you query too often anonymously
### gitignore-gen.sh
TBD
|
