From 169c1343d51f09f3501312440beaece5253d4c94 Mon Sep 17 00:00:00 2001 From: Rich Bennett Date: Fri, 2 Nov 2018 06:47:43 -0400 Subject: Add submodule information summary when running tox Add summary and advance sphinx requirement to latest stable release Change-Id: I4aae9c9e54bed7943beba24d9cb57f1338974ddf Issue-ID: DOC-332 Signed-off-by: Rich Bennett --- shell/smsummary.sh | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 shell/smsummary.sh (limited to 'shell') diff --git a/shell/smsummary.sh b/shell/smsummary.sh new file mode 100644 index 000000000..a4bd1d3fc --- /dev/null +++ b/shell/smsummary.sh @@ -0,0 +1,26 @@ +# Copyright (c) 2018 Open Network Automation Platform and contributors +# +# 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. + +# Create a list of submodules used to build documentation +# Usage: sh smsummary.sh output_file +# + +echo "************************************************************************************" > $1 +echo "* Submodule branches used to build this version of the documentation. *" >> $1 +echo "************************************************************************************" >> $1 + +git submodule foreach git for-each-ref \ + --format='%(committerdate:iso8601) %(objectname) %(HEAD) %(refname) %(subject)' \ + --sort -committerdate refs/heads/ | \ + sed -e 's:^: :' -e 's: Entering .docs/submodules/::' -e 's:.git.$::' -e 's:refs/heads/::' >> $1 -- cgit 1.2.3-korg