update_version.py 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414
  1. #!/usr/bin/env python3
  2. # Usage: ./update_version.py <MAJOR>.<MINOR>.<MICRO> [<RC version>]
  3. #
  4. # Example:
  5. # ./update_version.py 3.7.1 2
  6. # => Version will become 3.7.1-rc-2 (beta)
  7. # ./update_version.py 3.7.1
  8. # => Version will become 3.7.1 (stable)
  9. import datetime
  10. import re
  11. import sys
  12. from xml.dom import minidom
  13. if len(sys.argv) < 2 or len(sys.argv) > 3:
  14. print("""
  15. [ERROR] Please specify a version.
  16. ./update_version.py <MAJOR>.<MINOR>.<MICRO> [<RC version>]
  17. Example:
  18. ./update_version.py 3.7.1 2
  19. """)
  20. exit(1)
  21. NEW_VERSION = sys.argv[1]
  22. NEW_VERSION_INFO = [int(x) for x in NEW_VERSION.split('.')]
  23. if len(NEW_VERSION_INFO) != 3:
  24. print("""
  25. [ERROR] Version must be in the format <MAJOR>.<MINOR>.<MICRO>
  26. Example:
  27. ./update_version.py 3.7.3
  28. """)
  29. exit(1)
  30. RC_VERSION = -1
  31. if len(sys.argv) > 2:
  32. RC_VERSION = int(sys.argv[2])
  33. def Find(elem, tagname):
  34. for child in elem.childNodes:
  35. if child.nodeName == tagname:
  36. return child
  37. return None
  38. def FindAndClone(elem, tagname):
  39. return Find(elem, tagname).cloneNode(True)
  40. def ReplaceText(elem, text):
  41. elem.firstChild.replaceWholeText(text)
  42. def GetFullVersion(rc_suffix = '-rc-'):
  43. if RC_VERSION < 0:
  44. return NEW_VERSION
  45. else:
  46. return '%s%s%s' % (NEW_VERSION, rc_suffix, RC_VERSION)
  47. def GetSharedObjectVersion():
  48. protobuf_version_offset = 11
  49. expected_major_version = 3
  50. if NEW_VERSION_INFO[0] != expected_major_version:
  51. print("""[ERROR] Major protobuf version has changed. Please update
  52. update_version.py to readjust the protobuf_version_offset and
  53. expected_major_version such that the PROTOBUF_VERSION in src/Makefile.am is
  54. always increasing.
  55. """)
  56. exit(1)
  57. return [NEW_VERSION_INFO[1] + protobuf_version_offset, NEW_VERSION_INFO[2], 0]
  58. def RewriteXml(filename, rewriter, add_xml_prefix=True):
  59. document = minidom.parse(filename)
  60. rewriter(document)
  61. # document.toxml() always prepend the XML version without inserting new line.
  62. # We wants to preserve as much of the original formatting as possible, so we
  63. # will remove the default XML version and replace it with our custom one when
  64. # whever necessary.
  65. content = document.toxml().replace('<?xml version="1.0" ?>', '')
  66. file_handle = open(filename, 'wb')
  67. if add_xml_prefix:
  68. file_handle.write(b'<?xml version="1.0" encoding="UTF-8"?>\n')
  69. file_handle.write(content.encode('utf-8'))
  70. file_handle.write(b'\n')
  71. file_handle.close()
  72. def RewriteTextFile(filename, line_rewriter):
  73. lines = open(filename, 'r').readlines()
  74. updated_lines = []
  75. for line in lines:
  76. updated_lines.append(line_rewriter(line))
  77. if lines == updated_lines:
  78. print('%s was not updated. Please double check.' % filename)
  79. f = open(filename, 'w')
  80. f.write(''.join(updated_lines))
  81. f.close()
  82. def UpdateCMake():
  83. cmake_files = (
  84. 'cmake/libprotobuf.cmake',
  85. 'cmake/libprotobuf-lite.cmake',
  86. 'cmake/libprotoc.cmake'
  87. )
  88. for cmake_file in cmake_files:
  89. RewriteTextFile(cmake_file,
  90. lambda line : re.sub(
  91. r'SOVERSION ([0-9]+)$',
  92. 'SOVERSION %s' % GetSharedObjectVersion()[0],
  93. line))
  94. def UpdateConfigure():
  95. RewriteTextFile('configure.ac',
  96. lambda line : re.sub(
  97. r'^AC_INIT\(\[Protocol Buffers\],\[.*\],\[protobuf@googlegroups.com\],\[protobuf\]\)$',
  98. ('AC_INIT([Protocol Buffers],[%s],[protobuf@googlegroups.com],[protobuf])'
  99. % GetFullVersion()),
  100. line))
  101. def UpdateCpp():
  102. cpp_version = '%d%03d%03d' % (
  103. NEW_VERSION_INFO[0], NEW_VERSION_INFO[1], NEW_VERSION_INFO[2])
  104. version_suffix = ''
  105. if RC_VERSION != -1:
  106. version_suffix = '-rc%s' % RC_VERSION
  107. def RewriteCommon(line):
  108. line = re.sub(
  109. r'^#define GOOGLE_PROTOBUF_VERSION .*$',
  110. '#define GOOGLE_PROTOBUF_VERSION %s' % cpp_version,
  111. line)
  112. line = re.sub(
  113. r'^#define PROTOBUF_VERSION .*$',
  114. '#define PROTOBUF_VERSION %s' % cpp_version,
  115. line)
  116. line = re.sub(
  117. r'^#define GOOGLE_PROTOBUF_VERSION_SUFFIX .*$',
  118. '#define GOOGLE_PROTOBUF_VERSION_SUFFIX "%s"' % version_suffix,
  119. line)
  120. line = re.sub(
  121. r'^#define PROTOBUF_VERSION_SUFFIX .*$',
  122. '#define PROTOBUF_VERSION_SUFFIX "%s"' % version_suffix,
  123. line)
  124. if NEW_VERSION_INFO[2] == 0:
  125. line = re.sub(
  126. r'^#define PROTOBUF_MIN_HEADER_VERSION_FOR_PROTOC .*$',
  127. '#define PROTOBUF_MIN_HEADER_VERSION_FOR_PROTOC %s' % cpp_version,
  128. line)
  129. line = re.sub(
  130. r'^#define GOOGLE_PROTOBUF_MIN_PROTOC_VERSION .*$',
  131. '#define GOOGLE_PROTOBUF_MIN_PROTOC_VERSION %s' % cpp_version,
  132. line)
  133. line = re.sub(
  134. r'^static const int kMinHeaderVersionForLibrary = .*$',
  135. 'static const int kMinHeaderVersionForLibrary = %s;' % cpp_version,
  136. line)
  137. line = re.sub(
  138. r'^static const int kMinHeaderVersionForProtoc = .*$',
  139. 'static const int kMinHeaderVersionForProtoc = %s;' % cpp_version,
  140. line)
  141. return line
  142. def RewritePortDef(line):
  143. line = re.sub(
  144. r'^#define PROTOBUF_VERSION .*$',
  145. '#define PROTOBUF_VERSION %s' % cpp_version,
  146. line)
  147. line = re.sub(
  148. r'^#define PROTOBUF_VERSION_SUFFIX .*$',
  149. '#define PROTOBUF_VERSION_SUFFIX "%s"' % version_suffix,
  150. line)
  151. if NEW_VERSION_INFO[2] == 0:
  152. line = re.sub(
  153. r'^#define PROTOBUF_MIN_HEADER_VERSION_FOR_PROTOC .*$',
  154. '#define PROTOBUF_MIN_HEADER_VERSION_FOR_PROTOC %s' % cpp_version,
  155. line)
  156. line = re.sub(
  157. r'^#define PROTOBUF_MIN_PROTOC_VERSION .*$',
  158. '#define PROTOBUF_MIN_PROTOC_VERSION %s' % cpp_version,
  159. line)
  160. line = re.sub(
  161. r'^#define GOOGLE_PROTOBUF_MIN_LIBRARY_VERSION .*$',
  162. '#define GOOGLE_PROTOBUF_MIN_LIBRARY_VERSION %s' % cpp_version,
  163. line)
  164. return line
  165. def RewritePbH(line):
  166. line = re.sub(
  167. r'^#if PROTOBUF_VERSION < .*$',
  168. '#if PROTOBUF_VERSION < %s' % cpp_version,
  169. line)
  170. line = re.sub(
  171. r'^#if .* < PROTOBUF_MIN_PROTOC_VERSION$',
  172. '#if %s < PROTOBUF_MIN_PROTOC_VERSION' % cpp_version,
  173. line)
  174. return line
  175. RewriteTextFile('src/google/protobuf/stubs/common.h', RewriteCommon)
  176. RewriteTextFile('src/google/protobuf/port_def.inc', RewritePortDef)
  177. RewriteTextFile('src/google/protobuf/any.pb.h', RewritePbH)
  178. RewriteTextFile('src/google/protobuf/api.pb.h', RewritePbH)
  179. RewriteTextFile('src/google/protobuf/descriptor.pb.h', RewritePbH)
  180. RewriteTextFile('src/google/protobuf/duration.pb.h', RewritePbH)
  181. RewriteTextFile('src/google/protobuf/empty.pb.h', RewritePbH)
  182. RewriteTextFile('src/google/protobuf/field_mask.pb.h', RewritePbH)
  183. RewriteTextFile('src/google/protobuf/source_context.pb.h', RewritePbH)
  184. RewriteTextFile('src/google/protobuf/struct.pb.h', RewritePbH)
  185. RewriteTextFile('src/google/protobuf/timestamp.pb.h', RewritePbH)
  186. RewriteTextFile('src/google/protobuf/type.pb.h', RewritePbH)
  187. RewriteTextFile('src/google/protobuf/wrappers.pb.h', RewritePbH)
  188. RewriteTextFile('src/google/protobuf/compiler/plugin.pb.h', RewritePbH)
  189. def UpdateCsharp():
  190. RewriteXml('csharp/src/Google.Protobuf/Google.Protobuf.csproj',
  191. lambda document : ReplaceText(
  192. Find(Find(document.documentElement, 'PropertyGroup'), 'VersionPrefix'),
  193. GetFullVersion(rc_suffix = '-rc')),
  194. add_xml_prefix=False)
  195. RewriteXml('csharp/Google.Protobuf.Tools.nuspec',
  196. lambda document : ReplaceText(
  197. Find(Find(document.documentElement, 'metadata'), 'version'),
  198. GetFullVersion(rc_suffix = '-rc')))
  199. def UpdateJava():
  200. RewriteXml('java/pom.xml',
  201. lambda document : ReplaceText(
  202. Find(document.documentElement, 'version'), GetFullVersion()))
  203. RewriteXml('java/bom/pom.xml',
  204. lambda document : ReplaceText(
  205. Find(document.documentElement, 'version'), GetFullVersion()))
  206. RewriteXml('java/core/pom.xml',
  207. lambda document : ReplaceText(
  208. Find(Find(document.documentElement, 'parent'), 'version'),
  209. GetFullVersion()))
  210. RewriteXml('java/lite/pom.xml',
  211. lambda document : ReplaceText(
  212. Find(Find(document.documentElement, 'parent'), 'version'),
  213. GetFullVersion()))
  214. RewriteXml('java/util/pom.xml',
  215. lambda document : ReplaceText(
  216. Find(Find(document.documentElement, 'parent'), 'version'),
  217. GetFullVersion()))
  218. RewriteXml('java/kotlin/pom.xml',
  219. lambda document : ReplaceText(
  220. Find(Find(document.documentElement, 'parent'), 'version'),
  221. GetFullVersion()))
  222. RewriteXml('java/kotlin-lite/pom.xml',
  223. lambda document : ReplaceText(
  224. Find(Find(document.documentElement, 'parent'), 'version'),
  225. GetFullVersion()))
  226. RewriteXml('protoc-artifacts/pom.xml',
  227. lambda document : ReplaceText(
  228. Find(document.documentElement, 'version'), GetFullVersion()))
  229. RewriteTextFile('java/README.md',
  230. lambda line : re.sub(
  231. r'<version>.*</version>',
  232. '<version>%s</version>' % GetFullVersion(),
  233. line))
  234. RewriteTextFile('java/README.md',
  235. lambda line : re.sub(
  236. r'implementation \'com.google.protobuf:protobuf-java:.*\'',
  237. 'implementation \'com.google.protobuf:protobuf-java:%s\'' % GetFullVersion(),
  238. line))
  239. RewriteTextFile('java/lite.md',
  240. lambda line : re.sub(
  241. r'<version>.*</version>',
  242. '<version>%s</version>' % GetFullVersion(),
  243. line))
  244. def UpdateJavaScript():
  245. RewriteTextFile('js/package.json',
  246. lambda line : re.sub(
  247. r'^ "version": ".*",$',
  248. ' "version": "%s",' % GetFullVersion(rc_suffix = '-rc.'),
  249. line))
  250. def UpdateMakefile():
  251. RewriteTextFile('src/Makefile.am',
  252. lambda line : re.sub(
  253. r'^PROTOBUF_VERSION = .*$',
  254. 'PROTOBUF_VERSION = %s' % ":".join(map(str,GetSharedObjectVersion())),
  255. line))
  256. def UpdateObjectiveC():
  257. RewriteTextFile('Protobuf.podspec',
  258. lambda line : re.sub(
  259. r"^ s.version = '.*'$",
  260. " s.version = '%s'" % GetFullVersion(rc_suffix = '-rc'),
  261. line))
  262. RewriteTextFile('Protobuf-C++.podspec',
  263. lambda line : re.sub(
  264. r"^ s.version = '.*'$",
  265. " s.version = '%s'" % GetFullVersion(rc_suffix = '-rc'),
  266. line))
  267. def UpdatePhp():
  268. def Callback(document):
  269. def CreateNode(tagname, indent, children):
  270. elem = document.createElement(tagname)
  271. indent += 1
  272. for child in children:
  273. elem.appendChild(document.createTextNode('\n' + (' ' * indent)))
  274. elem.appendChild(child)
  275. indent -= 1
  276. elem.appendChild(document.createTextNode('\n' + (' ' * indent)))
  277. return elem
  278. root = document.documentElement
  279. now = datetime.datetime.now()
  280. ReplaceText(Find(root, 'date'), now.strftime('%Y-%m-%d'))
  281. ReplaceText(Find(root, 'time'), now.strftime('%H:%M:%S'))
  282. version = Find(root, 'version')
  283. ReplaceText(Find(version, 'release'), GetFullVersion(rc_suffix = 'RC'))
  284. ReplaceText(Find(version, 'api'), NEW_VERSION)
  285. stability = Find(root, 'stability')
  286. ReplaceText(Find(stability, 'release'),
  287. 'stable' if RC_VERSION < 0 else 'beta')
  288. ReplaceText(Find(stability, 'api'), 'stable' if RC_VERSION < 0 else 'beta')
  289. changelog = Find(root, 'changelog')
  290. for old_version in changelog.getElementsByTagName('version'):
  291. if Find(old_version, 'release').firstChild.nodeValue == NEW_VERSION:
  292. print ('[WARNING] Version %s already exists in the change log.'
  293. % NEW_VERSION)
  294. return
  295. if RC_VERSION != 0:
  296. changelog.appendChild(document.createTextNode(' '))
  297. release = CreateNode('release', 2, [
  298. CreateNode('version', 3, [
  299. FindAndClone(version, 'release'),
  300. FindAndClone(version, 'api')
  301. ]),
  302. CreateNode('stability', 3, [
  303. FindAndClone(stability, 'release'),
  304. FindAndClone(stability, 'api')
  305. ]),
  306. FindAndClone(root, 'date'),
  307. FindAndClone(root, 'time'),
  308. FindAndClone(root, 'license'),
  309. CreateNode('notes', 3, []),
  310. ])
  311. changelog.appendChild(release)
  312. changelog.appendChild(document.createTextNode('\n '))
  313. RewriteXml('php/ext/google/protobuf/package.xml', Callback)
  314. RewriteTextFile('php/ext/google/protobuf/protobuf.h',
  315. lambda line : re.sub(
  316. r"^#define PHP_PROTOBUF_VERSION .*$",
  317. "#define PHP_PROTOBUF_VERSION \"%s\"" % GetFullVersion(rc_suffix = 'RC'),
  318. line))
  319. def UpdatePython():
  320. RewriteTextFile('python/google/protobuf/__init__.py',
  321. lambda line : re.sub(
  322. r"^__version__ = '.*'$",
  323. "__version__ = '%s'" % GetFullVersion(rc_suffix = 'rc'),
  324. line))
  325. def UpdateRuby():
  326. RewriteXml('ruby/pom.xml',
  327. lambda document : ReplaceText(
  328. Find(document.documentElement, 'version'), GetFullVersion()))
  329. RewriteXml('ruby/pom.xml',
  330. lambda document : ReplaceText(
  331. Find(Find(Find(document.documentElement, 'dependencies'), 'dependency'), 'version'),
  332. GetFullVersion()))
  333. RewriteTextFile('ruby/google-protobuf.gemspec',
  334. lambda line : re.sub(
  335. r'^ s.version = ".*"$',
  336. ' s.version = "%s"' % GetFullVersion(rc_suffix = '.rc.'),
  337. line))
  338. def UpdateBazel():
  339. RewriteTextFile('protobuf_version.bzl',
  340. lambda line : re.sub(
  341. r"^PROTOBUF_VERSION = '.*'$",
  342. "PROTOBUF_VERSION = '%s'" % GetFullVersion(),
  343. line))
  344. UpdateCMake()
  345. UpdateConfigure()
  346. UpdateCsharp()
  347. UpdateCpp()
  348. UpdateJava()
  349. UpdateJavaScript()
  350. UpdateMakefile()
  351. UpdateObjectiveC()
  352. UpdatePhp()
  353. UpdatePython()
  354. UpdateRuby()
  355. UpdateBazel()