You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@solr.apache.org by ja...@apache.org on 2023/04/10 11:57:55 UTC
[solr] branch branch_9x updated: SOLR-16714 ReleaseWizard to add solrbot dependency upgrades to CHANGES (#1483)
This is an automated email from the ASF dual-hosted git repository.
janhoy pushed a commit to branch branch_9x
in repository https://gitbox.apache.org/repos/asf/solr.git
The following commit(s) were added to refs/heads/branch_9x by this push:
new 92c39fee856 SOLR-16714 ReleaseWizard to add solrbot dependency upgrades to CHANGES (#1483)
92c39fee856 is described below
commit 92c39fee856258684c7cad8939e9364e3e43bddc
Author: Jan Høydahl <ja...@users.noreply.github.com>
AuthorDate: Mon Apr 10 13:54:21 2023 +0200
SOLR-16714 ReleaseWizard to add solrbot dependency upgrades to CHANGES (#1483)
---
dev-tools/scripts/addDepsToChanges.py | 139 ++++++++++++++++++++++++++++++++++
dev-tools/scripts/releaseWizard.yaml | 25 ++++++
2 files changed, 164 insertions(+)
diff --git a/dev-tools/scripts/addDepsToChanges.py b/dev-tools/scripts/addDepsToChanges.py
new file mode 100755
index 00000000000..f82cc8fe58c
--- /dev/null
+++ b/dev-tools/scripts/addDepsToChanges.py
@@ -0,0 +1,139 @@
+#!/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.
+# 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.
+
+"""
+Script to add solrbot changes lines to CHANGES.txt
+"""
+import os
+import sys
+
+sys.path.append(os.path.dirname(__file__))
+from scriptutil import *
+
+import argparse
+import re
+
+line_re = re.compile(r"(.*?) \(#(\d+)\)$")
+
+
+def get_prev_release_tag(ver):
+ """
+ Based on a given version, compute the git tag for the "previous" version to calculate changes since.
+ For a major version, we want all solrbot commits since last release, i.e. X-1.Y.Z
+ For a minor version, we want all solrbot commits since X.Y-1.0
+ For a patch version, we want all solrbot commits since X.Y.Z-1
+ """
+ releases_arr = run('git tag |grep "releases/solr" | cut -c 15-').strip().split("\n")
+ releases = list(map(lambda x: Version.parse(x), releases_arr))
+ if ver.is_major_release():
+ last = releases.pop()
+ return "releases/solr/%s" % last.dot
+ if ver.is_minor_release():
+ return "releases/solr/%s.%s.0" % (ver.major, ver.minor - 1)
+ if ver.is_bugfix_release():
+ return "releases/solr/%s.%s.%s" % (ver.major, ver.minor, ver.bugfix - 1)
+ return None
+
+
+def read_config():
+ parser = argparse.ArgumentParser(description='Adds dependency changes section to CHANGES.txt.')
+ parser.add_argument('--version', type=Version.parse, help='Solr version to add changes to', required=True)
+ parser.add_argument('--user', default='solrbot', help='Git user to get changes for. Defaults to solrbot')
+ newconf = parser.parse_args()
+ return newconf
+
+
+def gitlog_to_changes(line, user="solrbot"):
+ """
+ Converts a git log formatted line ending in (#<pr-num) into a CHANGES style line
+ """
+ match = line_re.search(line)
+
+ if match:
+ text = match.group(1)
+ pr_num = match.group(2)
+ return "* PR#%s: %s (%s)\n" % (pr_num, text, user)
+ else:
+ return None
+
+
+def update_changes(filename, version, changes_lines):
+ """
+ Edits CHANGES.txt in-place
+ """
+ buffer = []
+ found_ver = False
+ found_header = False
+ appended = False
+ with open(filename) as f:
+ version_re = re.compile(r' %s ===' % (version))
+ header_re = re.compile(r'^Dependency Upgrades')
+ header_line_re = re.compile(r'^----')
+ for line in f:
+ if not found_ver:
+ buffer.append(line)
+ if version_re.search(line):
+ found_ver = True
+ continue
+ if not found_header:
+ buffer.append(line)
+ if header_re.search(line):
+ found_header = True
+ continue
+ if not appended:
+ if header_line_re.search(line):
+ buffer.append(line)
+ appended = True
+ for change_line in changes_lines:
+ buffer.append(change_line)
+ buffer.append("\n")
+ continue
+ buffer.append(line)
+ if appended:
+ with open(filename, 'w') as f:
+ f.write(''.join(buffer))
+ else:
+ if not found_ver:
+ print("Did not find version %s in CHANGES.txt" % version.dot)
+ elif not found_header:
+ print("Did not find header 'Dependency Upgrades' under version %s in CHANGES.txt" % version.dot)
+ exit(1)
+
+
+def main():
+ if not os.path.exists('solr/CHANGES.txt'):
+ sys.exit("Tool must be run from the root of a source checkout.")
+ newconf = read_config()
+ prev_tag = get_prev_release_tag(newconf.version)
+ print("Adding dependency updates since git tag %s" % prev_tag)
+ try:
+ gitlog_lines = run(
+ 'git log --author=' + newconf.user + ' --oneline --no-merges --pretty=format:"%s" ' + prev_tag + '..').split(
+ "\n")
+ changes_lines = list(map(lambda l: gitlog_to_changes(l, newconf.user), gitlog_lines))
+ update_changes('solr/CHANGES.txt', newconf.version, changes_lines)
+ print("Done")
+ except subprocess.CalledProcessError:
+ print("Error running git log - check your --version")
+ sys.exit(1)
+
+
+if __name__ == '__main__':
+ try:
+ main()
+ except KeyboardInterrupt:
+ print('\nReceived Ctrl-C, exiting early')
diff --git a/dev-tools/scripts/releaseWizard.yaml b/dev-tools/scripts/releaseWizard.yaml
index 502aa51bbaa..03fbf075c29 100644
--- a/dev-tools/scripts/releaseWizard.yaml
+++ b/dev-tools/scripts/releaseWizard.yaml
@@ -600,6 +600,31 @@ groups:
----
types:
- bugfix
+ - !Todo
+ id: dependency_updates_changes
+ title: Add dependency updates to CHANGES.txt
+ description: Bulk add all 'solrbot' dependency updates since last release
+ depends: clean_git_checkout
+ commands: !Commands
+ root_folder: '{{ git_checkout_folder }}'
+ commands_text: We call out to a helper script that modifies CHANGES.txt, and then commit it.
+ confirm_each_command: true
+ commands:
+ - !Command
+ cmd: git checkout {{ release_branch }}
+ stdout: true
+ - !Command
+ cmd: python3 -u dev-tools/scripts/addDepsToChanges.py --user solrbot --version {{ release_version }}
+ tee: true
+ - !Command
+ cmd: "{{ editor }} solr/CHANGES.txt"
+ comment: |
+ Verify that the modifications in CHANGES.txt under the 'Dependency Upgrades' are ok.
+ Look for duplicates, especially when a committer has manually added a similar entry for the same upgrade.
+ stdout: true
+ - !Command
+ cmd: git add -u . && git commit -m "Add dependency updates to CHANGES for {{ release_version }}" && git push
+ logfile: dependency-changes.log
- !Todo
id: draft_release_notes
title: Get a draft of the release notes in place