Add submodule information summary when running tox
[doc.git] / shell / smsummary.sh
1 # Copyright (c) 2018 Open Network Automation Platform and contributors
2 #
3 #  Licensed under the Apache License, Version 2.0 (the "License");
4 #  you may not use this file except in compliance with the License.
5 #  You may obtain a copy of the License at
6 #
7 #           http://www.apache.org/licenses/LICENSE-2.0
8 #
9 #  Unless required by applicable law or agreed to in writing,
10 #  software distributed under the License is distributed on an
11 #  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
12 #  either express or implied. See the License for the specific
13 #  language governing permissions and limitations under the License.
14
15 # Create a list of submodules used to build documentation
16 # Usage:   sh smsummary.sh output_file
17 #
18
19 echo "************************************************************************************" > $1
20 echo "* Submodule branches used to build this version of the documentation.              *" >> $1
21 echo "************************************************************************************" >> $1
22
23 git submodule foreach git for-each-ref \
24   --format='%(committerdate:iso8601) %(objectname) %(HEAD) %(refname) %(subject)' \
25   --sort -committerdate refs/heads/ | \
26   sed -e 's:^:       :' -e 's:       Entering .docs/submodules/::' -e 's:.git.$::' -e 's:refs/heads/::' >> $1