# Licensed under the Apache License, Version 2.0 (the "License"); you may # not use this file except in compliance with the License. You may obtain # a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the # License for the specific language governing permissions and limitations # under the License. import errno import logging import os.path import yaml from reno import defaults LOG = logging.getLogger(__name__) _TEMPLATE = """\ --- prelude: > Replace this text with content to appear at the top of the section for this release. All of the prelude content is merged together and then rendered separately from the items listed in other parts of the file, so the text needs to be worded so that both the prelude and the other items make sense when read independently. This may mean repeating some details. Not every release note requires a prelude. Usually only notes describing major features or adding release theme details should have a prelude. features: - | List new features here, or remove this section. All of the list items in this section are combined when the release notes are rendered, so the text needs to be worded so that it does not depend on any information only available in another section, such as the prelude. This may mean repeating some details. issues: - | List known issues here, or remove this section. All of the list items in this section are combined when the release notes are rendered, so the text needs to be worded so that it does not depend on any information only available in another section, such as the prelude. This may mean repeating some details. upgrade: - | List upgrade notes here, or remove this section. All of the list items in this section are combined when the release notes are rendered, so the text needs to be worded so that it does not depend on any information only available in another section, such as the prelude. This may mean repeating some details. deprecations: - | List deprecations notes here, or remove this section. All of the list items in this section are combined when the release notes are rendered, so the text needs to be worded so that it does not depend on any information only available in another section, such as the prelude. This may mean repeating some details. critical: - | Add critical notes here, or remove this section. All of the list items in this section are combined when the release notes are rendered, so the text needs to be worded so that it does not depend on any information only available in another section, such as the prelude. This may mean repeating some details. security: - | Add security notes here, or remove this section. All of the list items in this section are combined when the release notes are rendered, so the text needs to be worded so that it does not depend on any information only available in another section, such as the prelude. This may mean repeating some details. fixes: - | Add normal bug fixes here, or remove this section. All of the list items in this section are combined when the release notes are rendered, so the text needs to be worded so that it does not depend on any information only available in another section, such as the prelude. This may mean repeating some details. other: - | Add other notes here, or remove this section. All of the list items in this section are combined when the release notes are rendered, so the text needs to be worded so that it does not depend on any information only available in another section, such as the prelude. This may mean repeating some details. """ class Config(object): _FILENAME = 'config.yaml' _OPTS = { # The notes subdirectory within the relnotesdir where the # notes live. 'notesdir': 'notes', # Should pre-release versions be merged into the final release # of the same number (1.0.0.0a1 notes appear under 1.0.0). 'collapse_pre_releases': True, # Should the scanner stop at the base of a branch (True) or go # ahead and scan the entire history (False)? 'stop_at_branch_base': True, # The git branch to scan. Defaults to the "current" branch # checked out. 'branch': None, # The earliest version to be included. This is usually the # lowest version number, and is meant to be the oldest # version. 'earliest_version': None, # The template used by reno new to create a note. 'template': _TEMPLATE, # The RE pattern used to match the repo tags representing a valid # release version. The pattern is compiled with the verbose and unicode # flags enabled. 'release_tag_re': ''' ((?:[\d.ab]|rc)+) # digits, a, b, and rc cover regular and # pre-releases ''', # The RE pattern used to check if a valid release version tag is also a # valid pre-release version. The pattern is compiled with the verbose # and unicode flags enabled. The pattern must define a group called # 'pre_release' that matches the pre-release part of the tag and any # separator, e.g for pre-release version '12.0.0.0rc1' the default RE # pattern will identify '.0rc1' as the value of the group # 'pre_release'. 'pre_release_tag_re': ''' (?P\.\d+(?:[ab]|rc)+\d*)$ ''', # The pattern for names for branches that are relevant when # scanning history to determine where to stop, to find the # "base" of a branch. Other branches are ignored. 'branch_name_re': 'stable/.+', # The identifiers and names of permitted sections in the # release notes, in the order in which the final report will # be generated. A prelude section will always be automatically # inserted before the first element of this list. 'sections': [ ['features', 'New Features'], ['issues', 'Known Issues'], ['upgrade', 'Upgrade Notes'], ['deprecations', 'Deprecation Notes'], ['critical', 'Critical Issues'], ['security', 'Security Issues'], ['fixes', 'Bug Fixes'], ['other', 'Other Notes'], ], } @classmethod def get_default(cls, opt): "Return the default for an option." try: return cls._OPTS[opt] except KeyError: raise ValueError('unknown option name %r' % (opt,)) def __init__(self, reporoot, relnotesdir=None): """Instantiate a Config object :param str reporoot: The root directory of the repository. :param str relnotesdir: The directory containing release notes. Defaults to 'releasenotes'. """ self.reporoot = reporoot if relnotesdir is None: relnotesdir = defaults.RELEASE_NOTES_SUBDIR self.relnotesdir = relnotesdir # Initialize attributes from the defaults. self.override(**self._OPTS) self._filename = os.path.join(self.reporoot, relnotesdir, self._FILENAME) self._contents = {} self._load_file() def _load_file(self): try: with open(self._filename, 'r') as fd: self._contents = yaml.safe_load(fd) except IOError as err: if err.errno == errno.ENOENT: LOG.info('no configuration file in %s', self._filename) else: LOG.warning('did not load config file %s: %s', self._filename, err) else: self.override(**self._contents) def override(self, **kwds): """Set the values of the named configuration options. Take the values of the keyword arguments as the current value of the same option, regardless of whether a value is already present. """ for n, v in kwds.items(): if n not in self._OPTS: LOG.warning('ignoring unknown configuration value %r = %r', n, v) else: setattr(self, n, v) def override_from_parsed_args(self, parsed_args): """Set the values of the configuration options from parsed CLI args. This method assumes that the DEST values for the command line arguments are named the same as the configuration options. """ arg_values = { o: getattr(parsed_args, o) for o in self._OPTS.keys() if hasattr(parsed_args, o) } self.override(**arg_values) @property def reporoot(self): return self._reporoot # Ensure that the 'reporoot' value always only ends in one '/'. @reporoot.setter def reporoot(self, value): self._reporoot = value.rstrip('/') + '/' @property def notespath(self): "The path in the repo where notes are kept." return os.path.join(self.relnotesdir, self.notesdir) # def parse_config_into(parsed_arguments): # """Parse the user config onto the namespace arguments. # :param parsed_arguments: # The result of calling :meth:`argparse.ArgumentParser.parse_args`. # :type parsed_arguments: # argparse.Namespace # """ # config_path = get_config_path(parsed_arguments.relnotesdir) # config_values = read_config(config_path) # for key in config_values.keys(): # try: # getattr(parsed_arguments, key) # except AttributeError: # LOG.info('Option "%s" does not apply to this particular command.' # '. Ignoring...', key) # continue # setattr(parsed_arguments, key, config_values[key]) # parsed_arguments._config = config_values