-
Notifications
You must be signed in to change notification settings - Fork 295
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update changelog for 0.43.0 release. (#2702)
Signed-off-by: Michael Robinson <[email protected]>
- Loading branch information
1 parent
4194d28
commit beb00b8
Showing
2 changed files
with
106 additions
and
71 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,135 +1,147 @@ | ||
| #!/bin/bash | ||
| #!/usr/bin/env python3 | ||
| # | ||
| # Copyright 2018-2023 contributors to the Marquez project | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| from github import Github | ||
| import rich_click as click | ||
| from datetime import date | ||
| from typing import TYPE_CHECKING | ||
|
|
||
| import rich_click as click | ||
| from github import Github | ||
|
|
||
| if TYPE_CHECKING: | ||
| from github.PullRequest import PullRequest | ||
|
|
||
| class GetChanges: | ||
|
|
||
| class GetChanges: | ||
| def __init__(self, github_token: str, previous: str, current: str, path: str): | ||
| self.github_token = github_token | ||
| self.previous = previous | ||
| self.current = current | ||
| self.path = path | ||
| self.pulls: list[PullRequest] = [] | ||
| self.rel_title_str: str = '' | ||
| self.rel_title_str: str = "" | ||
| self.text: list[str] = [] | ||
| self.new_contributors: dict[str:str] = {} | ||
|
|
||
| def get_pulls(self): | ||
| print('Working on it...') | ||
| print("Working on it...") | ||
| g = Github(self.github_token) | ||
| repo = g.get_repo("MarquezProject/marquez") | ||
| prev_date = repo.get_release(self.previous).created_at | ||
| commits = repo.get_commits(since=prev_date) | ||
| self.pulls = [pull for commit in commits for pull in commit.get_pulls()] | ||
|
|
||
| def write_title(self): | ||
| self.rel_title_str = f'## [{self.current}](https://github.com/MarquezProject/marquez/compare/{self.previous}...{self.current}) - {date.today()}' | ||
| self.rel_title_str = f"## [{self.current}](https://github.com/MarquezProject/marquez/compare/{self.previous}...{self.current}) - {date.today()}" # noqa: E501 | ||
|
|
||
| def describe_changes(self): | ||
| for pull in self.pulls: | ||
|
|
||
| """ Assembles change description with PR and user URLs """ | ||
| entry = [] | ||
| if pull.user.login != 'dependabot[bot]': | ||
| if pull.user.login != "dependabot[bot]": | ||
| labels = [] | ||
| for label in pull.labels: | ||
| if label.name != 'documentation': | ||
| if label.name != "documentation": | ||
| labels.append(label.name) | ||
| change_str = f'* **{labels[0]}: {pull.title}** [`#{pull.number}`]({pull.html_url}) [@{pull.user.login}]({pull.user.html_url}) ' | ||
|
|
||
| try: | ||
| change_str = f"* **{labels[0]}: {pull.title}** [`#{pull.number}`]({pull.html_url}) [@{pull.user.login}]({pull.user.html_url}) " # noqa: E501 | ||
| except Exception: | ||
| continue | ||
| """ Extracts one-line description if present """ | ||
| beg = pull.body.find('One-line summary:') + 18 | ||
| if beg == 17: | ||
| change_descrip_str = ' **' | ||
| else: | ||
| test = pull.body.find('### Checklist') | ||
| if test == -1: | ||
| end = beg + 75 | ||
| try: | ||
| beg = pull.body.find("One-line summary:") + 18 | ||
| if beg == 17: # noqa: PLR2004 | ||
| change_descrip_str = " **" | ||
| else: | ||
| end = test - 1 | ||
| descrip = pull.body[beg:end].split() | ||
| descrip_str = ' '.join(descrip) | ||
| change_descrip_str = f' *{descrip_str}*' | ||
|
|
||
| entry.append(change_str + '\n') | ||
| entry.append(change_descrip_str + '\n') | ||
| test = pull.body.find("### Checklist") | ||
| end = beg + 75 if test == -1 else test - 1 | ||
| descrip = pull.body[beg:end].split() | ||
| descrip_str = " ".join(descrip) | ||
| change_descrip_str = f" *{descrip_str}*" | ||
| except Exception: | ||
| continue | ||
|
|
||
| """ Checks for new contributor """ | ||
| self.check_new_contributor(pull) | ||
|
|
||
| entry.append(change_str + "\n") | ||
| entry.append(change_descrip_str + "\n") | ||
| self.text.append(entry) | ||
|
|
||
| def get_new_contributors(self): | ||
| for pull in self.pulls: | ||
| comments = pull.get_issue_comments() | ||
| for comment in comments: | ||
| if 'Thanks for opening your' in comment.body: | ||
| self.new_contributors[pull.user.login] = pull.user.url | ||
| def check_new_contributor(self, pull): | ||
| comments = pull.get_issue_comments() | ||
| for comment in comments: | ||
| if "Thanks for opening your" in comment.body: | ||
| self.new_contributors[pull.user.login] = pull.user.url | ||
|
|
||
| def print_new_contributors(self): | ||
| if self.new_contributors: | ||
| print('New contributors:') | ||
| print("New contributors:") | ||
| for k, v in self.new_contributors.items(): | ||
| print(f'@{k}: {v}') | ||
| print(f"@{k}: {v}") | ||
| else: | ||
| print('Note: no new contributors were found.') | ||
| print("Note: no new contributors were identified.") | ||
|
|
||
| def update_changelog(self): | ||
| f = open('changes.txt', 'w+') | ||
| f = open('changes.txt', 'a') | ||
| f.write(self.rel_title_str + '\n') | ||
| for entry in self.text: | ||
| for line in entry: | ||
| f.write(line) | ||
| f.close() | ||
|
|
||
| with open('changes.txt', 'r+') as f: | ||
| with open("changes.txt", "a") as f: | ||
| f.write(self.rel_title_str + "\n") | ||
| for entry in self.text: | ||
| for line in entry: | ||
| f.write(line) | ||
| f.close() | ||
|
|
||
| with open("changes.txt", "r+") as f: | ||
| new_changes = f.read() | ||
| with open(self.path, 'r') as contents: | ||
| with open(self.path) as contents: | ||
| save = contents.read() | ||
| with open(self.path, 'w') as contents: | ||
| with open(self.path, "w") as contents: | ||
| contents.write(new_changes) | ||
| with open(self.path, 'a') as contents: | ||
| with open(self.path, "a") as contents: | ||
| contents.write(save) | ||
|
|
||
|
|
||
| @click.command() | ||
| @click.option( | ||
| '--github_token', type=str, default='' | ||
| "--github_token", | ||
| type=str, | ||
| default="", | ||
| ) | ||
| @click.option( | ||
| "--previous", type=str, default='' | ||
| "--previous", | ||
| type=str, | ||
| default="", | ||
| ) | ||
| @click.option( | ||
| "--current", type=str, default='' | ||
| "--current", | ||
| type=str, | ||
| default="", | ||
| ) | ||
| @click.option( | ||
| "--path", | ||
| type=str, | ||
| default='', | ||
| help='absolute path to changelog', | ||
| "--path", | ||
| type=str, | ||
| default="../marquez/CHANGELOG.md", | ||
| help="path to changelog", | ||
| ) | ||
|
|
||
| def main( | ||
| github_token: str, | ||
| previous: str, | ||
| current: str, | ||
| path: str, | ||
| ): | ||
| c = GetChanges( | ||
| github_token=github_token, | ||
| previous=previous, | ||
| current=current, | ||
| path=path | ||
| github_token=github_token, | ||
| previous=previous, | ||
| current=current, | ||
| path=path, | ||
| ) | ||
| c.get_pulls() | ||
| c.describe_changes() | ||
| c.write_title() | ||
| c.update_changelog() | ||
| c.get_new_contributors() | ||
| print('...done!') | ||
| c.print_new_contributors() | ||
| print("...done!") | ||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| main() | ||
|
|