2 # Copyright © 2019-2020 Intel Corporation
4 # Permission is hereby granted, free of charge, to any person obtaining a copy
5 # of this software and associated documentation files (the "Software"), to deal
6 # in the Software without restriction, including without limitation the rights
7 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 # copies of the Software, and to permit persons to whom the Software is
9 # furnished to do so, subject to the following conditions:
11 # The above copyright notice and this permission notice shall be included in
12 # all copies or substantial portions of the Software.
14 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22 """Generates release notes for a given version of mesa."""
35 from mako
.template
import Template
36 from mako
import exceptions
39 CURRENT_GL_VERSION
= '4.6'
40 CURRENT_VK_VERSION
= '1.2'
42 TEMPLATE
= Template(textwrap
.dedent("""\
47 Mesa ${this_version} is a new development release. People who are concerned
48 with stability and reliability should stick with a previous release or
49 wait for Mesa ${this_version[:-1]}1.
51 Mesa ${this_version} is a bug fix release which fixes bugs found since the ${previous_version} release.
54 Mesa ${this_version} implements the OpenGL ${gl_version} API, but the version reported by
55 glGetString(GL_VERSION) or glGetIntegerv(GL_MAJOR_VERSION) /
56 glGetIntegerv(GL_MINOR_VERSION) depends on the particular driver being used.
57 Some drivers don't support all the features required in OpenGL ${gl_version}. OpenGL
58 ${gl_version} is **only** available if requested at context creation.
59 Compatibility contexts may report a lower version depending on each driver.
61 Mesa ${this_version} implements the Vulkan ${vk_version} API, but the version reported by
62 the apiVersion property of the VkPhysicalDeviceProperties struct
63 depends on the particular driver being used.
91 %for c, author_line in changes:
103 async def gather_commits(version
: str) -> str:
104 p
= await asyncio
.create_subprocess_exec(
105 'git', 'log', '--oneline', f
'mesa-{version}..', '--grep', r
'Closes: \(https\|#\).*',
106 stdout
=asyncio
.subprocess
.PIPE
)
107 out
, _
= await p
.communicate()
108 assert p
.returncode
== 0, f
"git log didn't work: {version}"
109 return out
.decode().strip()
112 async def gather_bugs(version
: str) -> typing
.List
[str]:
113 commits
= await gather_commits(version
)
115 issues
: typing
.List
[str] = []
116 for commit
in commits
.split('\n'):
117 sha
, message
= commit
.split(maxsplit
=1)
118 p
= await asyncio
.create_subprocess_exec(
119 'git', 'log', '--max-count', '1', r
'--format=%b', sha
,
120 stdout
=asyncio
.subprocess
.PIPE
)
121 _out
, _
= await p
.communicate()
122 out
= _out
.decode().split('\n')
123 for line
in reversed(out
):
124 if line
.startswith('Closes:'):
125 bug
= line
.lstrip('Closes:').strip()
128 raise Exception('No closes found?')
129 if bug
.startswith('h'):
130 # This means we have a bug in the form "Closes: https://..."
131 issues
.append(os
.path
.basename(urllib
.parse
.urlparse(bug
).path
))
133 issues
.append(bug
.lstrip('#'))
135 loop
= asyncio
.get_event_loop()
136 async with aiohttp
.ClientSession(loop
=loop
) as session
:
137 results
= await asyncio
.gather(*[get_bug(session
, i
) for i
in issues
])
138 typing
.cast(typing
.Tuple
[str, ...], results
)
145 async def get_bug(session
: aiohttp
.ClientSession
, bug_id
: str) -> str:
146 """Query gitlab to get the name of the issue that was closed."""
147 # Mesa's gitlab id is 176,
148 url
= 'https://gitlab.freedesktop.org/api/v4/projects/176/issues'
149 params
= {'iids[]': bug_id
}
150 async with session
.get(url
, params
=params
) as response
:
151 content
= await response
.json()
152 return content
[0]['title']
155 async def get_shortlog(version
: str) -> str:
156 """Call git shortlog."""
157 p
= await asyncio
.create_subprocess_exec('git', 'shortlog', f
'mesa-{version}..',
158 stdout
=asyncio
.subprocess
.PIPE
)
159 out
, _
= await p
.communicate()
160 assert p
.returncode
== 0, 'error getting shortlog'
161 assert out
is not None, 'just for mypy'
165 def walk_shortlog(log
: str) -> typing
.Generator
[typing
.Tuple
[str, bool], None, None]:
166 for l
in log
.split('\n'):
167 if l
.startswith(' '): # this means we have a patch description
168 yield l
.lstrip(), False
173 def calculate_next_version(version
: str, is_point
: bool) -> str:
174 """Calculate the version about to be released."""
176 version
= version
.split('-')[0]
178 base
= version
.split('.')
179 base
[2] = str(int(base
[2]) + 1)
180 return '.'.join(base
)
184 def calculate_previous_version(version
: str, is_point
: bool) -> str:
185 """Calculate the previous version to compare to.
187 In the case of -rc to final that verison is the previous .0 release,
188 (19.3.0 in the case of 20.0.0, for example). for point releases that is
189 the last point release. This value will be the same as the input value
190 for a point release, but different for a major release.
193 version
= version
.split('-')[0]
196 base
= version
.split('.')
198 base
[0] = str(int(base
[0]) - 1)
201 base
[1] = str(int(base
[1]) - 1)
202 return '.'.join(base
)
205 def get_features(is_point_release
: bool) -> typing
.Generator
[str, None, None]:
206 p
= pathlib
.Path(__file__
).parent
.parent
/ 'docs' / 'relnotes' / 'new_features.txt'
209 print("WARNING: new features being introduced in a point release", file=sys
.stderr
)
210 with p
.open('rt') as f
:
220 async def main() -> None:
221 v
= pathlib
.Path(__file__
).parent
.parent
/ 'VERSION'
222 with v
.open('rt') as f
:
223 raw_version
= f
.read().strip()
224 is_point_release
= '-rc' not in raw_version
225 assert '-devel' not in raw_version
, 'Do not run this script on -devel'
226 version
= raw_version
.split('-')[0]
227 previous_version
= calculate_previous_version(version
, is_point_release
)
228 this_version
= calculate_next_version(version
, is_point_release
)
229 today
= datetime
.date
.today()
230 header
= f
'Mesa {this_version} Release Notes / {today}'
231 header_underline
= '=' * len(header
)
233 shortlog
, bugs
= await asyncio
.gather(
234 get_shortlog(previous_version
),
235 gather_bugs(previous_version
),
238 final
= pathlib
.Path(__file__
).parent
.parent
/ 'docs' / 'relnotes' / f
'{this_version}.rst'
239 with final
.open('wt') as f
:
241 f
.write(TEMPLATE
.render(
242 bugfix
=is_point_release
,
244 changes
=walk_shortlog(shortlog
),
245 features
=get_features(is_point_release
),
246 gl_version
=CURRENT_GL_VERSION
,
247 this_version
=this_version
,
249 header_underline
=header_underline
,
250 previous_version
=previous_version
,
251 vk_version
=CURRENT_VK_VERSION
,
254 print(exceptions
.text_error_template().render())
256 subprocess
.run(['git', 'add', final
])
257 subprocess
.run(['git', 'commit', '-m',
258 f
'docs: add release notes for {this_version}'])
261 if __name__
== "__main__":
262 loop
= asyncio
.get_event_loop()
263 loop
.run_until_complete(main())