diff --git a/RELEASE_NOTES.rst b/RELEASE_NOTES.rst index 61dd29b7..7075db64 100644 --- a/RELEASE_NOTES.rst +++ b/RELEASE_NOTES.rst @@ -1,6 +1,12 @@ Release notes ============= +0.24 +---- + +* Added ``doc-tools-update-cli-reference``, a wrapper script to update + CLI references in the ``openstack-manuals`` repository. + 0.23 ---- diff --git a/bin/doc-tools-update-cli-reference b/bin/doc-tools-update-cli-reference new file mode 100755 index 00000000..31e70551 --- /dev/null +++ b/bin/doc-tools-update-cli-reference @@ -0,0 +1,73 @@ +#!/bin/bash + +# 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. + +if [[ $# -ne 1 ]]; then + echo "usage: $0 PROJECT" + echo + echo "PROJECT = something like keystone, glance, or nova" + exit 1 +fi + +project=$1 + +if [[ ! -e /usr/bin/virtualenv ]]; then + echo "error: virtualenv not installed" + exit 1 +fi + +if [[ ! -e /usr/bin/pip ]]; then + echo "error: pip not installed" + exit 1 +fi + +if [[ ! -e /usr/bin/git ]]; then + echo "error: git not installed" + exit 1 +fi + +if [[ ! -e $HOME/.gitconfig ]]; then + echo "note: ~/.gitconfig does not exist" +fi + +if [[ ! -e .venv ]]; then + virtualenv .venv +fi + +source .venv/bin/activate + +pip install --upgrade openstack-doc-tools +pip install --upgrade pbr +pip install --upgrade python-${project}client + +rm -rf output +mkdir output + +openstack-auto-commands --output-dir output $project + +if [[ ! -e openstack-manuals ]]; then + git clone git://git.openstack.org/openstack/openstack-manuals +fi + +cd openstack-manuals + +( git remote -v | grep -q gerrit ) || git review -s + +git checkout master +git pull +branch=update_client_$project +git branch --list $branch && git branch -D $branch +git checkout -b $branch +mv ../output/ch_cli_${project}_commands.xml doc/cli-reference/generated +version=$($project --version 2>&1) +git commit -a -m "Update CLI reference for python-${project}client $version" diff --git a/setup.cfg b/setup.cfg index 2dc2acba..7e976c11 100644 --- a/setup.cfg +++ b/setup.cfg @@ -26,6 +26,7 @@ data_files = share/openstack-doc-tools/cleanup = cleanup/* scripts = bin/doc-tools-check-languages + bin/doc-tools-update-cli-reference [global] setup-hooks =