1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
|
#!/usr/bin/env python3
# Copyright 2016-2021 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 <https://www.gnu.org/licenses/>.
"""Check if docs changed and output an error if so."""
import sys
import subprocess
import os
import os.path
sys.path.insert(0, os.path.join(os.path.dirname(__file__), os.pardir,
os.pardir))
from scripts import utils
code = subprocess.run(['git', '--no-pager', 'diff', '--exit-code', '--stat',
'--', 'doc'], check=False).returncode
if os.environ.get('GITHUB_REF', 'refs/heads/main') != 'refs/heads/main':
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 utils.ON_CI:
utils.gha_error('The autogenerated docs changed')
print()
with utils.gha_group('Diff'):
subprocess.run(['git', '--no-pager', 'diff'], check=True)
sys.exit(code)
|
