Bài viết gốc Use Git Hooks to Automate Necessary but Annoying Tasks
Một số tasks thật sự cần chạy sau khi pull code hoặc check out sang một branch chẳng hạn như cập nhật các dependencies hoặc migrate database, re-index ctags để cải thiện trải nghiệm tốt hơn khi phát triển các ứng dụng. Bên cạnh đó các bạn dev thường xuyên quên làm nó dẫn đến dễ bị lỗi. Để xác định vấn đề gần đây có một bộ git hooks với dotfiles để tự động làm các task đó.
Git Hooks
Git có tính năng thường sử dụng đó là hooks . Các bạn có thể coi một hook là một event kích hoạt trước và sau một số trạng thái trong quá trình kiểm soát sửa đổi. Các hooks cần chú ý gồm có:
prepare-commit-msg– Fire trước commit message.pre-commit– Fire trước mộtgit commit.post-commit– Fire sau mộtgit commit.post-checkout– Fire sau thay đổi các branches.post-merge– Fire sau merging các branches.pre-push– Fire trước code pushed lên một remote.
Mở rộng các Hooks
Dotfiles convention for extension là nơi để tùy chỉnh các hooks trong các file {pre,post}-$EVENT trong thư mục {~/.git_template.local/hooks}.
Đến đây bất cứ chúng ta thêm vào các hook files sẽ tự động thực thi chạy các task mà chúng ta thường xuyên quên.
Các tasks thường xuyên quên
Quên chạy re-index
ctags!
Các dòng code dưới đây sẽ re-index cho các bạn sau mỗi command git
1 2 3 4 5 6 7 8 9 10 11 12 | <span class="token comment"># ~/.git_template.local/hooks/ctags</span> <span class="token comment">#!/bin/sh</span> <span class="token builtin class-name">set</span> -e <span class="token assign-left variable"><span class="token environment constant">PATH</span></span><span class="token operator">=</span><span class="token string">"/usr/local/bin:<span class="token environment constant">$PATH</span>"</span> <span class="token assign-left variable">dir</span><span class="token operator">=</span><span class="token string">"<span class="token variable"><span class="token variable">$(</span><span class="token function">git</span> rev-parse --git-dir<span class="token variable">)</span></span>"</span> <span class="token builtin class-name">trap</span> <span class="token string">'rm -f "<span class="token variable">$dir</span>/<span class="token variable">$$</span>.tags"'</span> EXIT <span class="token function">git</span> ls-files <span class="token operator">|</span> <span class="token punctuation"></span> <span class="token string">"<span class="token variable">${CTAGS<span class="token operator">:-</span>ctags}</span>"</span> --tag-relative<span class="token operator">=</span>yes -L - -f<span class="token string">"<span class="token variable">$dir</span>/<span class="token variable">$$</span>.tags"</span> --languages<span class="token operator">=</span>-javascript,sql <span class="token function">mv</span> <span class="token string">"<span class="token variable">$dir</span>/<span class="token variable">$$</span>.tags"</span> <span class="token string">"<span class="token variable">$dir</span>/tags"</span> |
Quên chạy
bundle installsau khi checkout sang branch khác
Tự động cài các gem mới
1 2 3 4 5 6 7 8 9 10 | <span class="token comment"># ~/.git_template.local/hooks/post-checkout</span> <span class="token comment"># use `hookup` gem if it's installed</span> <span class="token keyword">if</span> <span class="token builtin class-name">command</span> -v hookup <span class="token operator">></span> /dev/null<span class="token punctuation">;</span> <span class="token keyword">then</span> hookup post-checkout <span class="token string">"<span class="token variable"><a href="/cdn-cgi/l/email-protection" class="__cf_email__">[email protected]</a></span>"</span> <span class="token keyword">else</span> <span class="token comment"># otherwise, do it yourself</span> <span class="token punctuation">[</span> -f Gemfile <span class="token punctuation">]</span> <span class="token operator">&&</span> bundle <span class="token function">install</span> <span class="token operator">></span> /dev/null <span class="token operator">&</span> <span class="token keyword">fi</span> |
Quên chạy các pending migrations
Tự động chạy các migrations
1 2 3 4 5 6 7 8 9 10 | <span class="token comment"># ~/.git_template.local/hooks/post-checkout</span> <span class="token comment"># use `hookup` gem if it's installed</span> <span class="token keyword">if</span> <span class="token builtin class-name">command</span> -v hookup <span class="token operator">></span> /dev/null<span class="token punctuation">;</span> <span class="token keyword">then</span> hookup post-checkout <span class="token string">"<span class="token variable"><a href="/cdn-cgi/l/email-protection" class="__cf_email__">[email protected]</a></span>"</span> <span class="token keyword">else</span> <span class="token comment"># otherwise, do it yourself</span> <span class="token punctuation">[</span> -f db/schema.rb <span class="token punctuation">]</span> <span class="token operator">&&</span> bin/rake db:migrate <span class="token operator">></span> /dev/null <span class="token operator">&</span> <span class="token keyword">fi</span> |
Viết document API với fdoc nhưng quên generate các page
Tự động generate các docs HTML
1 2 3 4 | <span class="token comment"># ~/.git_template.local/hooks/post-checkout</span> bin/fdoc convert ./spec/fixtures --output<span class="token operator">=</span>./html <span class="token operator">></span> /dev/null <span class="token operator">&</span> |
Quên Go commitment sang standard code format cho các files
Chạy go fmt trước commit
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 | <span class="token comment"># ~/.git_template.local/hooks/pre-commit</span> <span class="token assign-left variable">gofiles</span><span class="token operator">=</span><span class="token variable"><span class="token variable">$(</span><span class="token function">git</span> <span class="token function">diff</span> --cached --name-only --diff-filter<span class="token operator">=</span>ACM <span class="token operator">|</span> <span class="token function">grep</span> <span class="token string">'.go$'</span><span class="token variable">)</span></span> <span class="token punctuation">[</span> -z <span class="token string">"<span class="token variable">$gofiles</span>"</span> <span class="token punctuation">]</span> <span class="token operator">&&</span> <span class="token builtin class-name">exit</span> <span class="token number">0</span> <span class="token keyword">function</span> <span class="token function-name function">checkfmt</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token assign-left variable">unformatted</span><span class="token operator">=</span><span class="token variable"><span class="token variable">$(</span>gofmt -l $gofiles<span class="token variable">)</span></span> <span class="token punctuation">[</span> -z <span class="token string">"<span class="token variable">$unformatted</span>"</span> <span class="token punctuation">]</span> <span class="token operator">&&</span> <span class="token builtin class-name">return</span> <span class="token number">0</span> <span class="token builtin class-name">echo</span> <span class="token operator">></span><span class="token file-descriptor important">&2</span> <span class="token string">"Go files must be formatted with gofmt. Please run:"</span> <span class="token keyword">for</span> <span class="token for-or-select variable">fn</span> <span class="token keyword">in</span> <span class="token variable">$unformatted</span><span class="token punctuation">;</span> <span class="token keyword">do</span> <span class="token builtin class-name">echo</span> <span class="token operator">></span><span class="token file-descriptor important">&2</span> <span class="token string">" gofmt -w <span class="token environment constant">$PWD</span>/<span class="token variable">$fn</span>"</span> <span class="token keyword">done</span> <span class="token builtin class-name">return</span> <span class="token number">1</span> <span class="token punctuation">}</span> checkfmt <span class="token operator">||</span> <span class="token assign-left variable">fail</span><span class="token operator">=</span>yes <span class="token punctuation">[</span> -z <span class="token string">"<span class="token variable">$fail</span>"</span> <span class="token punctuation">]</span> <span class="token operator">||</span> <span class="token builtin class-name">exit</span> <span class="token number">1</span> <span class="token builtin class-name">exit</span> <span class="token number">0</span> |
Trong đó các bạn có thể tìm hiểu thêm về gem Hookup dành cho Rails bao gồm các phiên bản hook của Bundler và migration.
Chúng ta có thể tập trung cho việc quan trong hơn bằng cách đơn giản hóa và tự động hóa các phần việc nhỏ nhói trong quá trình phát triển rồi đấy 
Cảm ơn các bạn đã đọc bài viết.