mirror of https://github.com/apache/lucene.git
LUCENE-8852 ReleaseWizard tool (#710)
This commit is contained in:
Jan Høydahl
GitHub
parent
c6899fc40d
commit
87c131baa7
|
|
@ -27,3 +27,4 @@ pom.xml
|
|||
/nb-build
|
||||
.pydevproject
|
||||
__pycache__
|
||||
/dev-tools/scripts/scripts.iml
|
||||
|
|
|
|||
|
|
@ -0,0 +1,9 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<module type="PYTHON_MODULE" version="4">
|
||||
<component name="NewModuleRootManager" inherit-compiler-output="true">
|
||||
<exclude-output />
|
||||
<content url="file://$MODULE_DIR$" />
|
||||
<orderEntry type="jdk" jdkName="Python 3.7" jdkType="Python SDK" />
|
||||
<orderEntry type="sourceFolder" forTests="false" />
|
||||
</component>
|
||||
</module>
|
||||
|
|
@ -0,0 +1,211 @@
|
|||
# Developer Scripts
|
||||
|
||||
This folder contains various useful scripts for developers, mostly related to
|
||||
releasing new versions of Lucene/Solr and testing those.
|
||||
|
||||
Python scripts require Python 3. 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-solr-6.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-solr. 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, lucene/version.properties and
|
||||
solrconfig.xml 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/Solr git workspace. Downloads the Jenkins
|
||||
log pointed to by the given URL, parses it for Git revision and failed
|
||||
Lucene/Solr 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)
|
||||
|
||||
### poll-mirrors.py
|
||||
|
||||
usage: poll-mirrors.py [-h] [-version VERSION] [-path PATH]
|
||||
[-interval INTERVAL] [-details] [-once]
|
||||
|
||||
Periodically checks that all Lucene/Solr mirrors contain either a copy of a
|
||||
release or a specified path
|
||||
|
||||
optional arguments:
|
||||
-h, --help show this help message and exit
|
||||
-version VERSION, -v VERSION
|
||||
Lucene/Solr version to check
|
||||
-path PATH, -p PATH instead of a versioned release, check for
|
||||
some/explicit/path
|
||||
-interval INTERVAL, -i INTERVAL
|
||||
seconds to wait before re-querying mirrors
|
||||
-details, -d print missing mirror URLs
|
||||
-once, -o run only once
|
||||
|
||||
### 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
|
||||
|
||||
### publish-solr-ref-guide.sh
|
||||
|
||||
TBD
|
||||
|
||||
### prep-solr-ref-guide-rc.sh
|
||||
|
||||
TBD
|
||||
|
||||
## Tools to be removed
|
||||
|
||||
* svnBranchToGit.py
|
||||
* createPatch.py (svn)
|
||||
|
|
@ -1,3 +1,5 @@
|
|||
#!/usr/bin/env python3
|
||||
# -*- coding: utf-8 -*-
|
||||
# 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.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
#!/usr/bin/env python3
|
||||
# -*- coding: utf-8 -*-
|
||||
# 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.
|
||||
|
|
@ -174,7 +176,7 @@ def check_solr_version_tests():
|
|||
print('ok')
|
||||
|
||||
def read_config(current_version):
|
||||
parser = argparse.ArgumentParser(description='Add a new version')
|
||||
parser = argparse.ArgumentParser(description='Add a new version to CHANGES, to Version.java, lucene/version.properties and solrconfig.xml files')
|
||||
parser.add_argument('version', type=Version.parse)
|
||||
newconf = parser.parse_args()
|
||||
|
||||
|
|
@ -209,6 +211,8 @@ def get_solr_init_changes():
|
|||
''' % parse_properties_file('lucene/ivy-versions.properties'))
|
||||
|
||||
def main():
|
||||
if not os.path.exists('lucene/version.properties'):
|
||||
sys.exit("Tool must be run from the root of a source checkout.")
|
||||
current_version = Version.parse(find_current_version())
|
||||
newconf = read_config(current_version)
|
||||
|
||||
|
|
|
|||
|
|
@ -1,3 +1,5 @@
|
|||
#!/usr/bin/env python3
|
||||
# -*- coding: utf-8 -*-
|
||||
# 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.
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
|
|
@ -1,3 +1,5 @@
|
|||
#!/usr/bin/env python3
|
||||
# -*- coding: utf-8 -*-
|
||||
# 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.
|
||||
|
|
|
|||
|
|
@ -1,2 +1,8 @@
|
|||
six>=1.11.0
|
||||
Jinja2>=2.10.1
|
||||
PyYAML>=5.1
|
||||
holidays>=0.9.10
|
||||
ics>=0.4
|
||||
console-menu>=0.5.1
|
||||
PyGithub
|
||||
jira
|
||||
|
|
@ -130,6 +130,8 @@ Other
|
|||
|
||||
* LUCENE-8861: Script to find open Github PRs that needs attention (janhoy)
|
||||
|
||||
* LUCENE-8852: ReleaseWizard tool for release managers (janhoy)
|
||||
|
||||
======================= Lucene 8.1.1 =======================
|
||||
(No Changes)
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue