X-Git-Url: https://git.libre-soc.org/?a=blobdiff_plain;f=bin%2Fgen_release_notes.py;h=716f807b3174b9c288fc30adf83c10b25e07e720;hb=8e8701b43a0fc1997ecdb6a9557dd3e2c1a0d398;hp=2479eff68cfed195ca32ec1e83a5ef8bc08d9785;hpb=64af6b3bcf8f976ce1739798cbdfdbf334f017d9;p=mesa.git
diff --git a/bin/gen_release_notes.py b/bin/gen_release_notes.py
index 2479eff68cf..716f807b317 100755
--- a/bin/gen_release_notes.py
+++ b/bin/gen_release_notes.py
@@ -1,5 +1,5 @@
#!/usr/bin/env python3
-# Copyright © 2019 Intel Corporation
+# Copyright © 2019-2020 Intel Corporation
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
@@ -25,6 +25,7 @@ import asyncio
import datetime
import os
import pathlib
+import subprocess
import sys
import textwrap
import typing
@@ -39,87 +40,63 @@ CURRENT_GL_VERSION = '4.6'
CURRENT_VK_VERSION = '1.2'
TEMPLATE = Template(textwrap.dedent("""\
- <%!
- import html
- %>
-
-
-
-
-
-
Mesa ${next_version} Release Notes / ${today}
-
-
+ ${header}
+ ${header_underline}
+
%if not bugfix:
- Mesa ${next_version} is a new development release. People who are concerned
- with stability and reliability should stick with a previous release or
- wait for Mesa ${next_version[:-1]}1.
+ Mesa ${this_version} is a new development release. People who are concerned
+ with stability and reliability should stick with a previous release or
+ wait for Mesa ${this_version[:-1]}1.
%else:
- Mesa ${next_version} is a bug fix release which fixes bugs found since the ${version} release.
+ Mesa ${this_version} is a bug fix release which fixes bugs found since the ${previous_version} release.
%endif
-
-
- Mesa ${next_version} implements the OpenGL ${gl_version} API, but the version reported by
+
+ Mesa ${this_version} implements the OpenGL ${gl_version} API, but the version reported by
glGetString(GL_VERSION) or glGetIntegerv(GL_MAJOR_VERSION) /
glGetIntegerv(GL_MINOR_VERSION) depends on the particular driver being used.
Some drivers don't support all the features required in OpenGL ${gl_version}. OpenGL
- ${gl_version} is only available if requested at context creation.
+ ${gl_version} is **only** available if requested at context creation.
Compatibility contexts may report a lower version depending on each driver.
-
-
- Mesa ${next_version} implements the Vulkan ${vk_version} API, but the version reported by
+
+ Mesa ${this_version} implements the Vulkan ${vk_version} API, but the version reported by
the apiVersion property of the VkPhysicalDeviceProperties struct
depends on the particular driver being used.
-
-
SHA256 checksum
-
- TBD.
-
+ SHA256 checksum
+ ---------------
+ ::
-
New features
+ TBD.
+
+
+ New features
+ ------------
-
%for f in features:
- - ${html.escape(f)}
+ - ${f}
%endfor
-
-
Bug fixes
-
+ Bug fixes
+ ---------
+
%for b in bugs:
- - ${html.escape(b)}
+ - ${b}
%endfor
-
-
Changes
-
- %for c, author in changes:
- %if author:
- ${html.escape(c)}
+ Changes
+ -------
+ %for c, author_line in changes:
+ %if author_line:
+
+ ${c}
+
%else:
- - ${html.escape(c)}
+ - ${c}
%endif
%endfor
-
-
-
-
-
"""))
@@ -159,7 +136,10 @@ async def gather_bugs(version: str) -> typing.List[str]:
async with aiohttp.ClientSession(loop=loop) as session:
results = await asyncio.gather(*[get_bug(session, i) for i in issues])
typing.cast(typing.Tuple[str, ...], results)
- return list(results)
+ bugs = list(results)
+ if not bugs:
+ bugs = ['None']
+ return bugs
async def get_bug(session: aiohttp.ClientSession, bug_id: str) -> str:
@@ -185,8 +165,8 @@ async def get_shortlog(version: str) -> str:
def walk_shortlog(log: str) -> typing.Generator[typing.Tuple[str, bool], None, None]:
for l in log.split('\n'):
if l.startswith(' '): # this means we have a patch description
- yield l, False
- else:
+ yield l.lstrip(), False
+ elif l.strip():
yield l, True
@@ -230,6 +210,9 @@ def get_features(is_point_release: bool) -> typing.Generator[str, None, None]:
with p.open('rt') as f:
for line in f:
yield line
+ else:
+ yield "None"
+ p.unlink()
else:
yield "None"
@@ -242,14 +225,17 @@ async def main() -> None:
assert '-devel' not in raw_version, 'Do not run this script on -devel'
version = raw_version.split('-')[0]
previous_version = calculate_previous_version(version, is_point_release)
- next_version = calculate_next_version(version, is_point_release)
+ this_version = calculate_next_version(version, is_point_release)
+ today = datetime.date.today()
+ header = f'Mesa {this_version} Release Notes / {today}'
+ header_underline = '=' * len(header)
shortlog, bugs = await asyncio.gather(
get_shortlog(previous_version),
gather_bugs(previous_version),
)
- final = pathlib.Path(__file__).parent.parent / 'docs' / 'relnotes' / f'{next_version}.html'
+ final = pathlib.Path(__file__).parent.parent / 'docs' / 'relnotes' / f'{this_version}.rst'
with final.open('wt') as f:
try:
f.write(TEMPLATE.render(
@@ -258,14 +244,19 @@ async def main() -> None:
changes=walk_shortlog(shortlog),
features=get_features(is_point_release),
gl_version=CURRENT_GL_VERSION,
- next_version=next_version,
- today=datetime.date.today(),
- version=previous_version,
+ this_version=this_version,
+ header=header,
+ header_underline=header_underline,
+ previous_version=previous_version,
vk_version=CURRENT_VK_VERSION,
))
except:
print(exceptions.text_error_template().render())
+ subprocess.run(['git', 'add', final])
+ subprocess.run(['git', 'commit', '-m',
+ f'docs: add release notes for {this_version}'])
+
if __name__ == "__main__":
loop = asyncio.get_event_loop()