2016-01-19 18:17:49 -05:00
|
|
|
#!/bin/bash -ex
|
|
|
|
|
|
|
|
# Copyright 2016 Hewlett Packard Enterprise Development Company, L.P.
|
|
|
|
#
|
|
|
|
# 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.
|
|
|
|
|
|
|
|
# This script is intended to be run as a periodic proposal bot job
|
|
|
|
# in OpenStack infrastructure, though you can run it as a one-off.
|
|
|
|
#
|
|
|
|
# In order to function correctly, the environment in which the
|
|
|
|
# script runs must have
|
2016-02-18 14:46:35 -05:00
|
|
|
# * a writable doc/source directory relative to the current
|
|
|
|
# working directory
|
|
|
|
# AND ( (
|
2016-01-19 18:17:49 -05:00
|
|
|
# * git
|
|
|
|
# * all git repos meant to be searched for plugins cloned and
|
|
|
|
# at the desired level of up-to-datedness
|
2016-02-18 14:46:35 -05:00
|
|
|
# * the environment variable git_dir pointing to the location
|
|
|
|
# * of said git repositories
|
|
|
|
# ) OR (
|
2019-06-04 17:30:13 +10:00
|
|
|
# * network access to the review.opendev.org Gerrit API
|
2016-01-19 18:17:49 -05:00
|
|
|
# working directory
|
2019-06-04 17:30:13 +10:00
|
|
|
# * network access to https://opendev.org
|
2016-02-18 14:46:35 -05:00
|
|
|
# ))
|
2016-01-19 18:17:49 -05:00
|
|
|
#
|
|
|
|
# If a file named data/devstack-plugins-registry.header or
|
|
|
|
# data/devstack-plugins-registry.footer is found relative to the
|
|
|
|
# current working directory, it will be prepended or appended to
|
|
|
|
# the generated reStructuredText plugins table respectively.
|
|
|
|
|
2016-03-21 13:03:34 +11:00
|
|
|
# Print the title underline for a RST table. Argument is the length
|
|
|
|
# of the first column, second column is assumed to be "URL"
|
|
|
|
function title_underline {
|
|
|
|
local len=$1
|
|
|
|
while [[ $len -gt 0 ]]; do
|
|
|
|
printf "="
|
|
|
|
len=$(( len - 1))
|
|
|
|
done
|
|
|
|
printf " ===\n"
|
|
|
|
}
|
|
|
|
|
2016-01-19 18:17:49 -05:00
|
|
|
(
|
2016-03-07 01:52:35 -05:00
|
|
|
if [[ -r data/devstack-plugins-registry.header ]]; then
|
|
|
|
cat data/devstack-plugins-registry.header
|
|
|
|
fi
|
2016-01-19 18:17:49 -05:00
|
|
|
|
2016-02-26 08:18:13 -07:00
|
|
|
sorted_plugins=$(python tools/generate-devstack-plugins-list.py)
|
|
|
|
|
2016-03-21 13:03:34 +11:00
|
|
|
# find the length of the name column & pad
|
|
|
|
name_col_len=$(echo "${sorted_plugins}" | wc -L)
|
|
|
|
name_col_len=$(( name_col_len + 2 ))
|
|
|
|
|
|
|
|
# ====================== ===
|
|
|
|
# Plugin Name URL
|
|
|
|
# ====================== ===
|
2019-03-04 17:26:20 +11:00
|
|
|
# foobar `https://... <https://...>`__
|
2016-03-21 13:03:34 +11:00
|
|
|
# ...
|
|
|
|
|
2016-04-06 09:27:56 +10:00
|
|
|
printf "\n\n"
|
2016-03-21 13:03:34 +11:00
|
|
|
title_underline ${name_col_len}
|
|
|
|
printf "%-${name_col_len}s %s\n" "Plugin Name" "URL"
|
|
|
|
title_underline ${name_col_len}
|
|
|
|
|
|
|
|
for plugin in ${sorted_plugins}; do
|
2019-06-04 17:30:13 +10:00
|
|
|
giturl="https://opendev.org/${plugin}"
|
|
|
|
gitlink="https://opendev.org/${plugin}"
|
2016-04-02 15:11:45 -04:00
|
|
|
printf "%-${name_col_len}s %s\n" "${plugin}" "\`${giturl} <${gitlink}>\`__"
|
2016-02-26 08:18:13 -07:00
|
|
|
done
|
2016-04-08 09:10:55 +10:00
|
|
|
|
|
|
|
title_underline ${name_col_len}
|
|
|
|
|
2016-04-06 09:27:56 +10:00
|
|
|
printf "\n\n"
|
2016-01-19 18:17:49 -05:00
|
|
|
|
2016-03-07 01:52:35 -05:00
|
|
|
if [[ -r data/devstack-plugins-registry.footer ]]; then
|
|
|
|
cat data/devstack-plugins-registry.footer
|
|
|
|
fi
|
2016-01-19 18:17:49 -05:00
|
|
|
) > doc/source/plugin-registry.rst
|
2016-02-26 08:25:32 -07:00
|
|
|
|
|
|
|
if [[ -n ${1} ]]; then
|
|
|
|
cp doc/source/plugin-registry.rst ${1}/doc/source/plugin-registry.rst
|
|
|
|
fi
|