X-Git-Url: https://git.libre-soc.org/?a=blobdiff_plain;f=bin%2Fgen_release_notes.py;h=716f807b3174b9c288fc30adf83c10b25e07e720;hb=4e65469c706184fc900fcfbae046ee0a645160c6;hp=3509879fa6fa02822600dc56472cf16956f56ab2;hpb=86079447da1e00d49db0cbff9a102eb4e71e8702;p=mesa.git diff --git a/bin/gen_release_notes.py b/bin/gen_release_notes.py index 3509879fa6f..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,8 @@ import asyncio import datetime import os import pathlib +import subprocess +import sys import textwrap import typing import urllib.parse @@ -35,93 +37,72 @@ from mako import exceptions CURRENT_GL_VERSION = '4.6' -CURRENT_VK_VERSION = '1.1' +CURRENT_VK_VERSION = '1.2' TEMPLATE = Template(textwrap.dedent("""\ - - - - - Mesa Release Notes - - - - -
-

The Mesa 3D Graphics Library

-
- - -
- -

Mesa ${next_version} Release Notes / ${today}

- -

- %if 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 ${version[:-1]}1. + ${header} + ${header_underline} + + %if not bugfix: + 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 + ------------ - -

Bug fixes

- -

Changes

- - -
- - """)) async def gather_commits(version: str) -> str: p = await asyncio.create_subprocess_exec( - 'git', 'log', f'mesa-{version}..', '--grep', r'Closes: \(https\|#\).*', + 'git', 'log', '--oneline', f'mesa-{version}..', '--grep', r'Closes: \(https\|#\).*', stdout=asyncio.subprocess.PIPE) out, _ = await p.communicate() assert p.returncode == 0, f"git log didn't work: {version}" @@ -149,13 +130,16 @@ async def gather_bugs(version: str) -> typing.List[str]: # This means we have a bug in the form "Closes: https://..." issues.append(os.path.basename(urllib.parse.urlparse(bug).path)) else: - issues.append(bug) + issues.append(bug.lstrip('#')) loop = asyncio.get_event_loop() 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: @@ -181,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 @@ -218,12 +202,19 @@ def calculate_previous_version(version: str, is_point: bool) -> str: return '.'.join(base) -def get_features() -> typing.Generator[str, None, None]: +def get_features(is_point_release: bool) -> typing.Generator[str, None, None]: p = pathlib.Path(__file__).parent.parent / 'docs' / 'relnotes' / 'new_features.txt' if p.exists(): + if is_point_release: + print("WARNING: new features being introduced in a point release", file=sys.stderr) with p.open('rt') as f: for line in f: yield line + else: + yield "None" + p.unlink() + else: + yield "None" async def main() -> None: @@ -234,30 +225,38 @@ 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( bugfix=is_point_release, bugs=bugs, changes=walk_shortlog(shortlog), - features=get_features(), + 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()