github 사용 유용한 팁 모음
github을 오랫동안 사용하고 있지만 그다지 잘 사용하지 못한 것 같아 새로 알게 되는 팁들을 정리해두려고 한다.
유용한 단축키
github이 제공하는 단축키를 사용하면 편하다
docs.github.com/en/github/getting-started-with-github/keyboard-shortcuts
Keyboard shortcuts - GitHub Docs
Nearly every page on GitHub has a keyboard shortcut to perform actions faster. Typing ? in GitHub brings up a dialog box that lists the keyboard shortcuts available for that page. You can use these keyboard shortcuts to perform actions across the site with
docs.github.com
사이트 전체 단축키
github의 모든 위치에서 사용이 가능한 단축키이다.
| 단축키 | 설명 |
| s 또는 / | 검색 창으로 이동 |
| g n | 알림으로 이동 (로그인 시에만 사용) |
| esc | user, issue 또는 pull request hovercard에 포커스가 있으면 hovercard를 닫고 hovercard가 있는 element에 다시 초점을 맞춤 |
| g d | 최상위 홈 (/) 으로 이동 |
github을 편하게 사용하는 시작점은 검색 창이다.
검색창은 아래의 항목을 검색할 수 있게 해 준다.
- Repositories
- Topics
- Issues and pull requests
- Discussions
- Code
- Commits
- Users
- Packages
- Wikis
github의 다양한 항목을 검색할 수 있지만 가장 비중이 높은 건 역시 repository 검색이다.
spring의 repository를 가고자 할 때 이 검색 기능을 활용하지 않으면 보통 주소창에 https://github.com/spring-project와 같이 github 계정 주소를 입력한 다음 자신이 원하는 repository를 검색하여 해당 repository를 찾게 되지만 검색을 활용하면 빠르게 원하는 repository를 찾을 수 있다.
이 검색창의 장점은 사용하는 유저/위치에 따라 결과가 다르게 나오기 때문에 자주 가는 repository는 점점 빠르게 검색 결과에 나오게 된다.
사용하다 보면 어느새 주소에 직접 입력하는 것보다 빠르게 이동하게 되는 것을 느낄 수 있다.
Repositories
repository 위치에서 사용할 수 있는 단축키이다.
아래 화면은 spring-project의 spring-boot repository 위치의 경우이다.
github.com/spring-projects/spring-boot/projects
repository 위치에서는 각 탭을 다음 열거된 단축키로 이동할 수 있다.
| 단축키 | 설명 |
| g c | Code 탭으로 이동 |
| g i | Issues 탭으로 이동 |
| g p | Pull requests 탭으로 이동 |
| g a | Actions 탭으로 이동 |
| g b | Project 탭으로 이동 (첫글자와 다른 단축키임) |
| g w | Wiki 탭으로 이동 |
| g s | Security 탭으로 이동 |
대부분은 g + 해당 탭의 첫 글자라서 외우기 쉽다.
insights 탭으로 이동하는 단축키는 아직 모르겠고 Project 탭으로 이동은 p가 아닌 b라는 점을 기억해야 한다.
(github 문서가 갱신이 안된 건지 모르겠지만 g s로 이동하는 단축키에 대한 설명이 없다.)
Source code editing
source code 탭에서 사용하는 편집 단축키는 사용을 그리 권장하지 않는다.
내 repository가 아닌 다른 곳에서 이 단축키를 눌러 editing 하면 해당 repository가 어느새 내 repository로 fork가 된다.
단축키를 사용하고자 하는 경우 github 문서를 참고하면 된다.
Source code browsing
| 단축키 | 설명 |
| t | file finder 활성화 |
| l | 해당 코드의 라인으로 이동 |
| w | branch 또는 tag switch |
| y | url을 표준 형식으로 확장, 특정 파일에 대한 영구적인 링크를 획득 |
| b | blame view 열기 |
자주 가는 repository에서 source code browsing 단축키는 매우 유용하다.
여기 소개한 단축키 이외에도 comment를 달거나 Issue와 pull request를 사용하는데 쓰이는 단축키도 있지만 오픈소스 커미터가 아니면 잘 쓰게 되지 않아 소개하지 않는다.
단축키를 사용하고자 하는 경우 github 문서를 참고하면 된다.
유용한 Github 브라우저 플러그인
github을 사용하면서 쓰기 편한 플러그인을 소개한다.
Octotree - GitHub code tree
Octotree
www.octotree.io
이 플러그인은 브라우저 왼쪽에 source code explorer를 추가해주는 플러그인이다.
github의 단축키를 잘 활용하게 되면 이 플러그인의 활용도가 낮아지게 되긴 하지만 IDE에서 보던 package explorer와 비슷한 형태로 보려고 하는 경우 유용하다.
Git History Browser Extension
github.com/LuisReinoso/git-history-browser-extension
LuisReinoso/git-history-browser-extension
Agrega un botón a la interfáz de archivos de github para ver su historial / Add a button to the github file interface to see its history - LuisReinoso/git-history-browser-extension
github.com
이 플러그인은 소스 코드의 history 별 코드를 직관적으로 보여주는 플러그인이다.
github이 제공하는 기본 history view는 일일이 commit별로 들어가서 변경점을 확인해야 하는 게 불편한데 이 플러그인을 깔면 키보드 방향키(← →)로 commit 별 전체 소스를 변화를 빠르게 볼 수 있어 편하다.
watch를 통한 메일링 활용
개인적으로 github에서 가장 쏠쏠하게 이용하는 기능은 watch의 custom 항목의 release event watch 기능이다.
github에는 릴리즈 된 jar를 등록하는 기능이 있다.
배포된 jar를 release에 등록하면 자동으로 등록 당시의 git source code를 생성하고 git history에 해당 태그를 생성해준다.
watch의 custom release event를 등록하면 해당 repository에 release가 배포될 때마다 내 메일로 해당 repository의 release 안내가 메일링 된다.
release에 대한 내용이 메일로 오기 때문에 새로 버전이 release 되는 것을 쉽게 알 수 있다.
만약 자신이 활발하게 참여하는 repository가 있다면 custom이 아닌 전체 activity를 메일링으로 받으면 편리하다.