-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathPrecommit_hooks.html
201 lines (168 loc) · 7.99 KB
/
Precommit_hooks.html
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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
<!DOCTYPE html>
<html lang="en">
<head>
<base href=".">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>pre-commit hooks</title>
<link rel="stylesheet" href="assets/css/dark-frontend.css" type="text/css" title="dark">
<link rel="alternate stylesheet" href="assets/css/light-frontend.css" type="text/css" title="light">
<link rel="stylesheet" href="assets/css/bootstrap-toc.min.css" type="text/css">
<link rel="stylesheet" href="assets/css/jquery.mCustomScrollbar.min.css">
<link rel="stylesheet" href="assets/js/search/enable_search.css" type="text/css">
<link rel="stylesheet" href="assets/css/prism-tomorrow.css" type="text/css" title="dark">
<link rel="alternate stylesheet" href="assets/css/prism.css" type="text/css" title="light">
<script src="assets/js/mustache.min.js"></script>
<script src="assets/js/jquery.js"></script>
<script src="assets/js/bootstrap.js"></script>
<script src="assets/js/scrollspy.js"></script>
<script src="assets/js/typeahead.jquery.min.js"></script>
<script src="assets/js/search.js"></script>
<script src="assets/js/compare-versions.js"></script>
<script src="assets/js/jquery.mCustomScrollbar.concat.min.js"></script>
<script src="assets/js/bootstrap-toc.min.js"></script>
<script src="assets/js/jquery.touchSwipe.min.js"></script>
<script src="assets/js/anchor.min.js"></script>
<script src="assets/js/tag_filtering.js"></script>
<script src="assets/js/language_switching.js"></script>
<script src="assets/js/styleswitcher.js"></script>
<script src="assets/js/lines_around_headings.js"></script>
<script src="assets/js/prism-core.js"></script>
<script src="assets/js/prism-autoloader.js"></script>
<script src="assets/js/prism_autoloader_path_override.js"></script>
<script src="assets/js/trie.js"></script>
<link rel="shortcut icon" href="assets/images/favicon.png">
</head>
<body class="no-script
">
<script>
$('body').removeClass('no-script');
</script>
<nav class="navbar navbar-fixed-top navbar-default" id="topnav">
<div class="container-fluid">
<div class="navbar-right">
<a id="toc-toggle">
<span class="glyphicon glyphicon-menu-right"></span>
<span class="glyphicon glyphicon-menu-left"></span>
</a>
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar-wrapper" aria-expanded="false">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<span title="light mode switch" class="glyphicon glyphicon-sunglasses pull-right" id="lightmode-icon"></span>
<form class="navbar-form pull-right" id="navbar-search-form">
<div class="form-group has-feedback">
<input type="text" class="form-control input-sm" name="search" id="sidenav-lookup-field" placeholder="search" disabled>
<span class="glyphicon glyphicon-search form-control-feedback" id="search-mgn-glass"></span>
</div>
</form>
</div>
<div class="navbar-header">
<a id="sidenav-toggle">
<span class="glyphicon glyphicon-menu-right"></span>
<span class="glyphicon glyphicon-menu-left"></span>
</a>
<a id="home-link" href="index.html" class="hotdoc-navbar-brand">
<img src="assets/images/pitivi.svg" alt="Home">
</a>
</div>
<div class="navbar-collapse collapse" id="navbar-wrapper">
<ul class="nav navbar-nav" id="menu">
</ul>
<div class="hidden-xs hidden-sm navbar-text navbar-center">
<p><b>The Pitivi Developer Documentation</b></p>
</div>
</div>
</div>
</nav>
<main>
<div data-extension="core" data-hotdoc-in-toplevel="True" data-hotdoc-project="Pitivi" data-hotdoc-ref="Precommit_hooks.html" class="page_container" id="page-wrapper">
<script src="assets/js/utils.js"></script>
<div class="panel panel-collapse oc-collapsed" id="sidenav" data-hotdoc-role="navigation">
<script src="assets/js/full-width.js"></script>
<div id="sitenav-wrapper">
<iframe src="hotdoc-sitemap.html" id="sitenav-frame"></iframe>
</div>
</div>
<div id="body">
<div id="main">
<div id="page-description" data-hotdoc-role="main">
<h1 id="precommit-hooks">pre-commit hooks</h1>
<p>When you enter the <a href="HACKING.html">development environment</a>, our <code>pre-commit.hook</code>
<a href="https://gitlab.gnome.org/GNOME/pitivi/-/blob/master/pre-commit.hook">script</a> is
symlinked in your local git repository as <code>.git/hooks/pre-commit</code>, serving as
the <a href="https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks">Git pre-commit
hook</a>.</p>
<p>When you make a git commit, the following happens:</p>
<ul>
<li>
<p>The <code>pre-commit.hook</code> script runs the (confusingly named) <code>pre-commit</code> tool
<strong>in the flatpak sandbox</strong>.</p>
</li>
<li>
<p>The <code>pre-commit</code> tool runs the hooks configured in
<a href="https://gitlab.gnome.org/GNOME/pitivi/-/blob/master/.pre-commit-config.yaml">.pre-commit-config.yaml</a></p>
</li>
</ul>
<p>Sooner or later you'll want to update the <code>pre-commit</code> framework and its hooks.</p>
<h2 id="how-to-update-the-precommit-tool">How to update the <code>pre-commit</code> tool</h2>
<p>The <code>pre-commit</code> tool is installed in the flatpak sandbox through
<a href="https://gitlab.gnome.org/GNOME/pitivi/-/blob/master/build/flatpak/python3-pre-commit.json">python3-pre-commit.json</a>.
The <code>python3-pre-commit.json</code> file is generated with <code>flatpak-pip-generator</code>.
See the instructions for <a href="Updating_Python_dependencies.html">updating the Python
dependencies</a>.</p>
<h2 id="how-to-update-the-hooks">How to update the hooks</h2>
<p>The <code>.pre-commit-config.yaml</code> file contains the list of hooks we use, grouped by
the git repo in which they can be found. The repos are downloaded and cached by
the <code>pre-commit</code> tool on demand. These hooks are executed <strong>each in their own
own virtualenv</strong>.</p>
<p>A special case is the <code>local</code> repo which groups the hooks installed alongside
the pre-commit framework, in the sandbox. We only need the <code>pylint</code> hook to be
run <strong>in the sandbox</strong> instead of in its own virtualenv, such that it has access
to the Python environment in the sandbox.</p>
<p>To update <code>pylint</code>, follow the instructions for <a href="Updating_Python_dependencies.html">updating the Python
dependencies</a>.</p>
<p>To update the regular hooks, take the repos one by one, check what is the latest
version and update the entry in the <code>.pre-commit-config.yaml</code> file. After
updating each repo, validate the entire codebase and fix all the newfound
errors.</p>
<p>For example, suppose we just updated the
<code>https://github.com/pre-commit/pre-commit-hooks.git</code> repo to revision <code>v3.4.0</code>:</p>
<pre><code> - repo: https://github.com/pre-commit/pre-commit-hooks.git
rev: v3.4.0
hooks:
- id: check-yaml
</code></pre>
<p>To run the <code>check-yaml</code> hook on the entire codebase:</p>
<pre><code>(ptv-flatpak) $ ptvenv pre-commit run -a check-yaml
</code></pre>
<p>If you feel brave, you can use <code>pre-commit</code> itself to update the hooks:</p>
<pre><code>(ptv-flatpak) $ ptvenv pre-commit autoupdate
</code></pre>
<p>At the end, do a final check by running all the hooks on the entire codebase:</p>
<pre><code>(ptv-flatpak) $ ptvenv pre-commit run -a
</code></pre>
</div>
</div>
<div id="search_results">
<p>The results of the search are</p>
</div>
<div id="footer">
</div>
</div>
<div id="toc-column">
<div class="edit-button">
<a href="https://gitlab.gnome.org/GNOME/pitivi/edit/master/docs/Precommit_hooks.md" data-hotdoc-role="edit-button">Edit on GitLab</a>
</div>
<div id="toc-wrapper">
<nav id="toc"></nav>
</div>
</div>
</div>
</main>
<script src="assets/js/navbar_offset_scroller.js"></script>
</body>
</html>