|
| 1 | +#!/usr/bin/env python |
| 2 | +import re |
| 3 | +import sys |
| 4 | +from pathlib import Path |
| 5 | + |
| 6 | +CHANGELOG = Path(__file__).parent.parent / 'Changelog' |
| 7 | + |
| 8 | +# Match release lines like "5.2.0 (Monday 11 December 2023)" |
| 9 | +RELEASE_REGEX = re.compile(r"""((?:\d+)\.(?:\d+)\.(?:\d+)) \(\w+ \d{1,2} \w+ \d{4}\)$""") |
| 10 | + |
| 11 | + |
| 12 | +def main(): |
| 13 | + version = sys.argv[1] |
| 14 | + output = sys.argv[2] |
| 15 | + if output == '-': |
| 16 | + output = sys.stdout |
| 17 | + else: |
| 18 | + output = open(output, 'w') |
| 19 | + |
| 20 | + release_notes = [] |
| 21 | + in_release_notes = False |
| 22 | + |
| 23 | + with open(CHANGELOG) as f: |
| 24 | + for line in f: |
| 25 | + match = RELEASE_REGEX.match(line) |
| 26 | + if match: |
| 27 | + if in_release_notes: |
| 28 | + break |
| 29 | + in_release_notes = match.group(1) == version |
| 30 | + next(f) # Skip the underline |
| 31 | + continue |
| 32 | + |
| 33 | + if in_release_notes: |
| 34 | + release_notes.append(line) |
| 35 | + |
| 36 | + # Drop empty lines at start and end |
| 37 | + while release_notes and not release_notes[0].strip(): |
| 38 | + release_notes.pop(0) |
| 39 | + while release_notes and not release_notes[-1].strip(): |
| 40 | + release_notes.pop() |
| 41 | + |
| 42 | + # Join lines |
| 43 | + release_notes = ''.join(release_notes) |
| 44 | + |
| 45 | + # Remove line breaks when they are followed by a space |
| 46 | + release_notes = re.sub(r'\n +', ' ', release_notes) |
| 47 | + |
| 48 | + # Replace pr/<number> with #<number> for GitHub |
| 49 | + release_notes = re.sub(r'\(pr/(\d+)\)', r'(#\1)', release_notes) |
| 50 | + |
| 51 | + # Replace :mod:`package.X` with [package.X](...) |
| 52 | + release_notes = re.sub( |
| 53 | + r':mod:`nibabel\.(.*)`', |
| 54 | + r'[nibabel.\1](https://nipy.org/nibabel/reference/nibabel.\1.html)', |
| 55 | + release_notes, |
| 56 | + ) |
| 57 | + # Replace :class/func/attr:`package.module.X` with [package.module.X](...) |
| 58 | + release_notes = re.sub( |
| 59 | + r':(?:class|func|attr):`(nibabel\.\w*)(\.[\w.]*)?\.(\w+)`', |
| 60 | + r'[\1\2.\3](https://nipy.org/nibabel/reference/\1.html#\1\2.\3)', |
| 61 | + release_notes, |
| 62 | + ) |
| 63 | + release_notes = re.sub( |
| 64 | + r':(?:class|func|attr):`~(nibabel\.\w*)(\.[\w.]*)?\.(\w+)`', |
| 65 | + r'[\3](https://nipy.org/nibabel/reference/\1.html#\1\2.\3)', |
| 66 | + release_notes, |
| 67 | + ) |
| 68 | + # Replace :meth:`package.module.class.X` with [package.module.class.X](...) |
| 69 | + release_notes = re.sub( |
| 70 | + r':meth:`(nibabel\.[\w.]*)\.(\w+)\.(\w+)`', |
| 71 | + r'[\1.\2.\3](https://nipy.org/nibabel/reference/\1.html#\1.\2.\3)', |
| 72 | + release_notes, |
| 73 | + ) |
| 74 | + release_notes = re.sub( |
| 75 | + r':meth:`~(nibabel\.[\w.]*)\.(\w+)\.(\w+)`', |
| 76 | + r'[\3](https://nipy.org/nibabel/reference/\1.html#\1.\2.\3)', |
| 77 | + release_notes, |
| 78 | + ) |
| 79 | + |
| 80 | + def python_doc(match): |
| 81 | + module = match.group(1) |
| 82 | + name = match.group(2) |
| 83 | + return f'[{name}](https://docs.python.org/3/library/{module.lower()}.html#{module}.{name})' |
| 84 | + |
| 85 | + release_notes = re.sub(r':meth:`~([\w.]+)\.(\w+)`', python_doc, release_notes) |
| 86 | + |
| 87 | + output.write('## Release notes\n\n') |
| 88 | + output.write(release_notes) |
| 89 | + |
| 90 | + output.close() |
| 91 | + |
| 92 | + |
| 93 | +if __name__ == '__main__': |
| 94 | + main() |
0 commit comments