Files
1032743e5410088b770bb454eda794b6f1d50a99
nova-specs /tools /abandon_spec.py
Eric Fried f1f7a9a154 Tools & docs for backlog & abandoned spec process 
Adds tooling and enhances README documentation around the backlog specs
process.
- To move a spec from the backlog to the current release, we can now use
 the ``move-spec`` tox target, e.g.
 tox -e move-spec -- [-n] [-v] specs/backlog/approved/great-idea.rst specs/train/approved
- To abandon a backlog spec - i.e. move it from specs/backlog/approved
 to the (new) specs/abandoned directory, we can now use the
 ``abandon-spec`` tox target, e.g.
 tox -e abandon-spec -- [-n] [-v] specs/backlog/it-was-a-great-idea.rst
These utilities will move the specified spec into the target directory
and create an appropriate redirect for it.
To make it so, this commit factors out a helper method that a) moves a
spec from one subdirectory to another and b) adds a redirect for it.
This is used by the existing ``move-implemented-specs`` utility as well
as the new ``move-spec`` and ``abandon-spec``.
While I was in here, I spruced up the verbose output (including for
move-implemented-specs) to be a bit more readable.
Change-Id: I322eecbacd5dc52accf6ac69c9fe1116be8c216f
2019年04月09日 15:23:16 +00:00

57 lines
1.9 KiB
Python

#!/usr/bin/env python
# Copyright 2019 OpenStack Foundation
#
# 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.
from __future__ import print_function
import argparse
import os
import lib
def get_options():
parser = argparse.ArgumentParser(
description='Move a spec to the `abandoned` folder and create a '
'redirect for it.')
parser.add_argument('-v', '--verbose', help='Enable verbose output',
action='store_true')
parser.add_argument('-n', '--dry-run',
help='Do everything except move/write the files',
action='store_true')
parser.add_argument('spec',
help='Path to the spec to be abandoned. For example, '
'specs/backlog/approved/it-was-a-great-idea.rst')
return parser.parse_args()
def abandon_spec(spec, verbose, dry_run):
spec_abs = os.path.abspath(spec)
if not os.path.exists(spec_abs):
raise ValueError('Could not find spec %s at %s' % (spec, spec_abs))
if not os.path.isfile(spec_abs):
raise ValueError('%s is not a regular file' % spec)
lib.move_spec(
spec_abs, os.path.abspath('specs/abandoned'), verbose, dry_run)
def main():
opts = get_options()
abandon_spec(opts.spec, opts.verbose, opts.dry_run)
if __name__ == '__main__':
main()