summaryrefslogtreecommitdiff
path: root/.config/qutebrowser/scripts/dev/check_doc_changes.py
diff options
context:
space:
mode:
authorVito Graffagnino <vito@graffagnino.xyz>2020-09-08 18:10:49 +0100
committerVito Graffagnino <vito@graffagnino.xyz>2020-09-08 18:10:49 +0100
commit3b0142cedcde39e4c2097ecd916a870a3ced5ec6 (patch)
tree2116c49a845dfc0945778f2aa3e2118d72be428b /.config/qutebrowser/scripts/dev/check_doc_changes.py
parent8cc927e930d5b6aafe3e9862a61e81705479a1b4 (diff)
Added the relevent parts of the .config directory. Alss add ssh config
Diffstat (limited to '.config/qutebrowser/scripts/dev/check_doc_changes.py')
-rwxr-xr-x.config/qutebrowser/scripts/dev/check_doc_changes.py48
1 files changed, 48 insertions, 0 deletions
diff --git a/.config/qutebrowser/scripts/dev/check_doc_changes.py b/.config/qutebrowser/scripts/dev/check_doc_changes.py
new file mode 100755
index 0000000..3d90bea
--- /dev/null
+++ b/.config/qutebrowser/scripts/dev/check_doc_changes.py
@@ -0,0 +1,48 @@
+#!/usr/bin/env python3
+# vim: ft=python fileencoding=utf-8 sts=4 sw=4 et:
+
+# Copyright 2016-2018 Florian Bruhin (The Compiler) <mail@qutebrowser.org>
+
+# This file is part of qutebrowser.
+#
+# qutebrowser is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# qutebrowser is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with qutebrowser. If not, see <http://www.gnu.org/licenses/>.
+
+"""Check if docs changed and output an error if so."""
+
+import sys
+import subprocess
+import os
+
+code = subprocess.run(['git', '--no-pager', 'diff',
+ '--exit-code', '--stat']).returncode
+
+if os.environ.get('TRAVIS_PULL_REQUEST', 'false') != 'false':
+ if code != 0:
+ print("Docs changed but ignoring change as we're building a PR")
+ sys.exit(0)
+
+if code != 0:
+ print()
+ print('The autogenerated docs changed, please run this to update them:')
+ print(' tox -e docs')
+ print(' git commit -am "Update docs"')
+ print()
+ print('(Or you have uncommitted changes, in which case you can ignore '
+ 'this.)')
+ if 'TRAVIS' in os.environ:
+ print()
+ print("travis_fold:start:gitdiff")
+ subprocess.run(['git', '--no-pager', 'diff'])
+ print("travis_fold:end:gitdiff")
+sys.exit(code)