-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #37 from dwhswenson/release-0.0.12
Release 0.0.12
- Loading branch information
Showing
18 changed files
with
500 additions
and
77 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
File renamed without changes.
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 |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| import: | ||
| - travis_stages/deploy_testpypi.yml | ||
| - travis_stages/cut_release.yml | ||
| - travis_stages/deploy_pypi.yml | ||
| - travis_stages/test_testpypi.yml |
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
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 |
|---|---|---|
| @@ -0,0 +1,189 @@ | ||
| #!/usr/bin/env python | ||
| from __future__ import print_function | ||
| import sys | ||
| import collections | ||
| import yaml | ||
| import requests | ||
| import dateutil.parser | ||
| import datetime | ||
|
|
||
| from .github_release import GitHubRepoBase, GitHubUser, ProjectOptions | ||
|
|
||
| class ReleaseNoteWriter(GitHubRepoBase): | ||
| def __init__(self, config, since_release=None, project=None, | ||
| github_user=None): | ||
| if isinstance(config, str): | ||
| with open(config) as f: | ||
| config = yaml.load(f.read(), Loader=yaml.SafeLoader) | ||
|
|
||
| self.config = config | ||
| self.since_release = since_release | ||
| project = self._apply_config_key(project, 'project', ProjectOptions) | ||
| github_user = self._apply_config_key(github_user, 'github_user', | ||
| GitHubUser) | ||
|
|
||
| super(ReleaseNoteWriter, self).__init__(project, github_user) | ||
| self._latest_release_tag = None | ||
| self._latest_release_tag_name = None | ||
| self._latest_release_commit_date = None | ||
|
|
||
| def _apply_config_key(self, var, key, obj_cls): | ||
| # this is to make codeclimate happy | ||
| if var is None and key in self.config.keys(): | ||
| var = obj_cls(**self.config[key]) | ||
| return var | ||
|
|
||
| def filter_recent_pulls(self, pulls, since): | ||
| # filter for date | ||
| pulls = [p for p in pulls if p['merged_at'] > since] | ||
| # ensure that you don't have the last PR from previous showing up | ||
| # (there can be a second in time difference between commit and | ||
| # merge) | ||
| latest_tag_sha = self._latest_release_tag['commit']['sha'] | ||
| pulls = [p for p in pulls | ||
| if p['merge_commit_sha'] != latest_tag_sha] | ||
| # print([p['number'] for p in pulls]) | ||
| return pulls | ||
|
|
||
| def label_organized_merged_pulls(self, since=''): | ||
| # the implementation challenge is that the return info from pulls | ||
| # doesn't currently include info about labels -- that is contains in | ||
| # the return info from issues (all pulls are issues). | ||
|
|
||
| # because of problems that the pull close date doesn't always match | ||
| # the issue close date (I see a difference of seconds), we look for | ||
| # any pulls/issues closed a minute before the last release. User can | ||
| # manually remove problematic things. | ||
| since_datetime = dateutil.parser.parse(since) | ||
| delta = datetime.timedelta(0, 60) | ||
| since = (since_datetime - delta).isoformat() | ||
| params = {'state': 'closed', 'since': since} | ||
| recent_pulls = self.api_get("pulls", params=params).json() | ||
| # print([p['number'] for p in recent_pulls], len(recent_pulls)) | ||
| # remove closed (unmerged) pulls | ||
| recent_pulls = [p for p in recent_pulls if p['merged_at'] is not None] | ||
| # print([p['number'] for p in recent_pulls], len(recent_pulls)) | ||
| # print([(p['number'], p['merged_at']) for p in recent_pulls]) | ||
| recent_pulls = self.filter_recent_pulls(recent_pulls, since) | ||
| issue_params = {'filter': 'all'} | ||
| issue_params.update(params) | ||
| recent_issues = self.api_get_json_all("issues", params=issue_params) | ||
| # print([(iss['number'], iss['closed_at']) for iss in recent_issues]) | ||
| issues_by_number = {iss['number']: iss for iss in recent_issues} | ||
| # print(list(issues_by_number.keys())) | ||
| desired_pulls = collections.defaultdict(list) | ||
| for pull in recent_pulls: | ||
| issue = issues_by_number[pull['number']] | ||
| label_names = [label['name'] for label in issue['labels']] | ||
| label_names = [None] if not label_names else label_names | ||
| for label in label_names: | ||
| desired_pulls[label] += [pull] | ||
|
|
||
| return desired_pulls | ||
|
|
||
| def _latest_release_tag_info(self, tag_name): | ||
| tags = self.api_get("tags").json() | ||
| desired_tag_list = [t for t in self.api_get("tags").json() | ||
| if t['name'] == tag_name] | ||
| assert len(desired_tag_list) == 1 | ||
| self._latest_release_tag = desired_tag_list[0] | ||
|
|
||
| @property | ||
| def latest_release_commit_date(self): | ||
| return self.set_release_info() | ||
|
|
||
| def release_commit_date(self, release_name=None): | ||
| # note that we use the date of the commit of the release, not the | ||
| # date of the release itself (can release long after the commit) | ||
| if release_name is None: | ||
| release_name = "latest" | ||
| else: | ||
| release_name = "tags/" + release_name | ||
|
|
||
| latest_release = self.api_get("releases/" + release_name).json() | ||
| if self._latest_release_tag_name != latest_release['tag_name']: | ||
| self._latest_release_tag_info(latest_release['tag_name']) | ||
| latest_tag_commit_sha = \ | ||
| self._latest_release_tag['commit']['sha'] | ||
| commit = self.api_get("commits/" + latest_tag_commit_sha).json() | ||
| self._latest_release_commit_date = \ | ||
| commit['commit']['committer']['date'] | ||
| self._latest_release_tag_name = latest_release['tag_name'] | ||
| return self._latest_release_commit_date | ||
|
|
||
| def write_pull_line(self, pull, extra_labels=None): | ||
| if extra_labels is None: | ||
| extra_labels = [] | ||
| title = pull['title'] | ||
| number = str(pull['number']) | ||
| author = pull['user']['login'] | ||
| out_str = "* " + title + " (#" + number + ")" | ||
| if author not in self.config['standard_contributors']: | ||
| out_str += " @" + author | ||
| for label in extra_labels: | ||
| out_str += " #" + label | ||
| out_str += "\n" | ||
| return out_str | ||
|
|
||
| @staticmethod | ||
| def _pull_to_labels(pull_dict): | ||
| pull_to_labels = collections.defaultdict(list) | ||
| for label in pull_dict: | ||
| for pull in pull_dict[label]: | ||
| pull_to_labels[pull['number']] += [label] | ||
| return pull_to_labels | ||
|
|
||
| def output_for_known_labels(self, pull_dict, pull_to_labels): | ||
| out_str = "" | ||
| for lbl in self.config['labels']: | ||
| label = lbl['label'] | ||
| out_str += "\n# " + lbl['heading'] + "\n" | ||
| for pull in pull_dict[label]: | ||
| pull_labels = set(pull_to_labels[pull['number']]) | ||
| extra_labels = pull_labels - set([label]) | ||
| out_str += self.write_pull_line(pull, extra_labels) | ||
| return out_str | ||
|
|
||
| def output_for_unknown_labels(self, pull_dict, unknown_labels, | ||
| treated_pulls): | ||
| out_str = "\n-----\n\n# Pulls with unknown labels\n" | ||
| for label in unknown_labels: | ||
| untreated = [pull for pull in pull_dict[label] | ||
| if pull['number'] not in treated_pulls] | ||
| if untreated: | ||
| out_str += "\n## " + str(label) + "\n" | ||
| for pull in untreated: | ||
| out_str += self.write_pull_line(pull) | ||
| treated_pulls.append(pull['number']) | ||
| return out_str | ||
|
|
||
| def release_notes_from_pulls(self, pull_dict): | ||
| config_labels = [lbl['label'] for lbl in self.config['labels']] | ||
| unknown_labels = set(pull_dict) - set(config_labels) | ||
| pull_to_labels = self._pull_to_labels(pull_dict) | ||
|
|
||
| config_label_pulls = sum([pull_dict[lbl] | ||
| for lbl in config_labels], []) | ||
| treated_pulls = set([p['number'] for p in config_label_pulls]) | ||
|
|
||
| out_str = self.output_for_known_labels(pull_dict, pull_to_labels) | ||
|
|
||
| if len(treated_pulls) != len(pull_to_labels): | ||
| out_str += self.output_for_unknown_labels(pull_dict, | ||
| unknown_labels, | ||
| list(treated_pulls)) | ||
| return out_str | ||
|
|
||
| def write_release_notes(self, outfile=None): | ||
| if outfile is None: | ||
| outfile = sys.stdout | ||
| elif isinstance(outfile, str): | ||
| outfile = open(outfile) | ||
| release_date = self.release_commit_date(self.since_release) | ||
| pull_dict = self.label_organized_merged_pulls(since=release_date) | ||
| notes = self.release_notes_from_pulls(pull_dict) | ||
| outfile.write(notes) | ||
| outfile.flush() | ||
| if outfile != sys.stdout: | ||
| outfile.close() | ||
|
|
Oops, something went wrong.