This repository has been archived by the owner on Mar 12, 2024. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
96ecce4
commit 5b8036f
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
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,195 @@ | ||
| #! /usr/bin/env python3 | ||
|
|
||
| """ | ||
| Command-line script to create or update the release page for a specific release. | ||
| """ | ||
| from os import path | ||
| from datetime import datetime | ||
| import sys | ||
| import logging | ||
|
|
||
| import click | ||
| import click_log | ||
| import yaml | ||
|
|
||
|
|
||
| # Add top-level module path to sys.path before importing tubular code. | ||
| sys.path.append(path.dirname(path.dirname(path.abspath(__file__)))) | ||
|
|
||
| from tubular.confluence_api import ReleasePage, publish_page, AMI, ReleaseStatus # pylint: disable=wrong-import-position | ||
| from tubular.github_api import ( # pylint: disable=wrong-import-position | ||
| default_expected_release_date, | ||
| ) | ||
|
|
||
| logging.basicConfig(stream=sys.stdout, level=logging.INFO) | ||
| LOG = logging.getLogger(__name__) | ||
|
|
||
| EXPECTED_RELEASE_DATE = default_expected_release_date() | ||
|
|
||
|
|
||
| @click.command("create_release_page") | ||
| @click.option( | ||
| '-c', '--compare', 'ami_pairs', | ||
| help=u"A pair of paths to AMI description yaml files.", | ||
| type=(click.File(), click.File()), | ||
| multiple=True | ||
| ) | ||
| @click.option( | ||
| '--confluence-url', | ||
| help=u"The base url of the confluence instance to publish the release page to.", | ||
| default='https://openedx.atlassian.net/wiki', | ||
| ) | ||
| @click.option( | ||
| '--user', | ||
| help=u"The username of the confluence user to post as.", | ||
| required=True, | ||
| ) | ||
| @click.option( | ||
| '--password', | ||
| help=u"The password for the confluence user.", | ||
| required=True, | ||
| ) | ||
| @click.option( | ||
| '--parent-title', | ||
| help=u"The title of the page to publish this page as a child of.", | ||
| ) | ||
| @click.option( | ||
| '--space', | ||
| help=u"The space to publish this page in.", | ||
| ) | ||
| @click.option( | ||
| '--title', | ||
| help=( | ||
| u"The title of this page. May contain the formatting value {timestamp} " | ||
| u"to insert the time of publishing into the wiki title. May also include `/` " | ||
| u"characters, which will create hierarchy pages that just display children." | ||
| ), | ||
| ) | ||
| @click.option( | ||
| '--github-token', | ||
| help=u"The token to use when accessing the github api.", | ||
| required=True, | ||
| ) | ||
| @click.option( | ||
| '--jira-url', | ||
| help=u"The base url for the JIRA instance to link JIRA tickets to.", | ||
| default='https://openedx.atlassian.net' | ||
| ) | ||
| @click.option( | ||
| '--gocd-url', | ||
| help=u"The url of the GoCD pipeline that build this release.", | ||
| ) | ||
| @click.option( | ||
| '--status', | ||
| help=u"The current status of this deployment", | ||
| required=True, | ||
| type=click.Choice(ReleaseStatus.__members__.keys()), # pylint: disable=no-member | ||
| ) | ||
| @click.option( | ||
| '--out-file', | ||
| help=u"File location to export metadata that can be used to update this page.", | ||
| type=click.File(mode='w'), | ||
| default=sys.stdout, | ||
| ) | ||
| @click.option( | ||
| '--in-file', | ||
| help=u"File location to import metadata from to specify a page to update.", | ||
| type=click.File(), | ||
| ) | ||
| @click_log.simple_verbosity_option(default=u'INFO') | ||
| def create_release_page( | ||
| ami_pairs, confluence_url, user, password, parent_title, | ||
| space, title, github_token, jira_url, gocd_url, status, | ||
| out_file, in_file | ||
| ): | ||
| """ | ||
| Create a new release page for edxapp. | ||
| """ | ||
| if in_file and any([parent_title, space, title]): | ||
| raise click.BadOptionUsage( | ||
| "in_file", | ||
| "Either --in-file or --parent-title/--space/--title must be specified, but not both." | ||
| ) | ||
|
|
||
| if in_file: | ||
| in_data = yaml.safe_load(in_file) | ||
| parent_title = in_data['parent_title'] | ||
| space = in_data['space'] | ||
| title = in_data['title'] | ||
|
|
||
| if title is None: | ||
| title = "{:%Y-%m-%d} Release".format(EXPECTED_RELEASE_DATE) | ||
|
|
||
| # This allows titles of the form "{timestamp:%Y-%m-%d} Release" and the like | ||
| # to format in the current timestamp | ||
| title = title.format(timestamp=datetime.now()) | ||
|
|
||
| folders = title.split('/')[:-1] | ||
| title = title.split('/')[-1] | ||
|
|
||
| if space is None: | ||
| space = 'RELEASES' | ||
|
|
||
| if parent_title is None: | ||
| parent_title = 'LMS/Studio Release Pages' | ||
|
|
||
| ami_pairs = [ | ||
| ( | ||
| AMI(**yaml.safe_load(old)), | ||
| AMI(**yaml.safe_load(new)) | ||
| ) | ||
| for old, new in ami_pairs | ||
| ] | ||
|
|
||
| page = ReleasePage( | ||
| github_token, | ||
| jira_url, | ||
| getattr(ReleaseStatus, status), | ||
| ami_pairs, | ||
| gocd_url=gocd_url, | ||
| ) | ||
|
|
||
| parent_id = None | ||
| parent_title_root = parent_title | ||
| for folder in folders: | ||
| result = publish_page( | ||
| confluence_url, | ||
| user, | ||
| password, | ||
| space, | ||
| folder, | ||
| """ | ||
| <ac:structured-macro | ||
| ac:name="children" | ||
| ac:schema-version="2" | ||
| data-layout="default" | ||
| ac:macro-id="f71dd203-0b29-4ece-bfaa-9f9e3106267d" | ||
| /> | ||
| """, | ||
| parent_title=parent_title, | ||
| parent_id=parent_id | ||
| ) | ||
| parent_title = None | ||
| parent_id = result[u'id'] | ||
|
|
||
| publish_page( | ||
| confluence_url, | ||
| user, | ||
| password, | ||
| space, | ||
| title, | ||
| page.format(), | ||
| parent_title=parent_title, | ||
| parent_id=parent_id | ||
| ) | ||
|
|
||
| yaml.safe_dump({ | ||
| 'parent_title': parent_title_root, | ||
| 'space': space, | ||
| 'title': title | ||
| }, stream=out_file) | ||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| # pylint: disable=no-value-for-parameter | ||
| create_release_page() | ||
