0. GitHub 프로필을 꾸며보자
본격적으로 개발 공부를 시작하면서, 방치해두던 GitHub도 관리해볼까 한다.
저장소야 뭐 개발하면서 혹은 공부하면서 작업한 작업물들을 잘 정리해서 올리면 되는 것이니 후순위로 빼기로 하고, 우선 프로필을 관리해보고자 한다.
대다수의 개발자분들이 GitHub를 사용하는만큼 프로필은 내가 얼마나 노력했는지, 어떤 기술 스택을 사용할 줄 아는지, 얼마나 깊이 있게 공부하고 있는지 간략하게 소개하는 중요한 소통 창구라고 생각한다.
그래서 한눈에 확 들어오면서도 보기 좋게 꾸미는게 중요한 것 같다.
마침, GitHub에서는 본인의 닉네임으로 저장소를 생성하면 계정 프로필에 README.md 파일을 추가할 수 있도록 지원해주고 있다.
그 부분을 사용하여 프로필을 꾸며보자.
1. 프로필 저장소 생성하기
우선 GitHub의 저장소 생성 버튼을 누른 후 저장소 이름을 본인의 계정 닉네임으로 설정해준다.
당연히 다른 사람들도 볼 수 있게 해야하므로 공개 설정은 Public으로 해주도록 하자.
그 후 마크다운 문서를 작성하기 위해 Add a README file 옵션도 체크하여 README.md 파일을 생성해 준다.
그리고 Create Repository 버튼을 클릭하면 된다.
2. README 작성하기
프로필 저장소를 생성하고 나면 이런 화면이 보일 것이다.
우측에 Edit README 버튼을 클릭하여 READEME 파일을 작성해주자.
이곳에 표시되어 있는 작성 예시처럼 마크다운 언어로 작성하면 된다.
3. 꾸미기
너무 텍스트만 있으면 딱딱하니 몇 가지 요소를 넣어 보자.
3-1. 기술스택 아이콘
개발자에게 있어서 중요한 어떤 기술을 사용할 줄 아는지 아이콘으로 한 번에 표시해보자.
<img src="https://img.shields.io/badge/표시할이름-색상?style=flat&logo=기술스택아이콘&logoColor=white">위 코드를 넣으면 기술 아이콘과 기술 이름을 넣을 수 있다.
아이콘은 Simple Icons 여기에 들어가면 찾을 수 있다.
위 사이트에서 Java는 찾을 수 없을텐데 그 이유는 Oracle 측에서 Java 아이콘에 대해 사용 금지를 요청해서 그렇다고 한다.
이런 식으로 뱃지가 표시된다.
3-2. BaekJoon 연결하기
GitHub 프로필에는 본인의 BaekJoon 티어를 비롯한 정보들을 표시할 수 있다.
<img align='right' src="http://mazassumnida.wtf/api/v2/generate_badge?boj=백준 닉네임">위 코드를 기입하면 된다.
그러면 이런식으로 프로필에 나타나게 된다.(나는 백준을 시작한지 얼마 안 되어서 아직 Rating이 없다. 🥲)
3-3. Wakatime 연결하기
Wakatime이란 본인의 순수 코딩 시간을 기록해주는 사이트이다.
상당히 유용해서 쓰고 있다.
물론 Wakatime에 가입한 후 본인이 사용하는 IDE에 플러그인을 설치한 후 API Key를 입력해야 사용할 수 있다.
어쨌든 이 Waktime을 프로필에 표시해보자.
<!--START_SECTION:waka-->
<!--END_SECTION:waka-->먼저 프로필 저장소의 README 파일에 위 코드를 작성해주자.
Wakatime 정보는 저 코드블록 안에 표시된다.
그리고 Wakatime 이곳에 들어가서 회원가입을 진행해준다.
그 후 계정 설정 이곳으로 들어가서 API Key를 발급받아 준다.
GitHub Token도 필요하니 기록해두자.
다음으로 GitHub Token 생성 이곳에서 Generate new token을 클릭하여 Token을 생성해준다.
만료일은 영구로 설정한다.
그리고 옵션으로 reop와 user 옵션을 체크한다.
다음엔 프로필 저장소로 들어가서 Setting -> Secrets으로 이동한다.
이후 사진에 나와 있는 버튼을 클릭하여 Secret Key를 추가해준다.
이 때 GitHub Token은 Name을 GH_TOKEN으로 Wakatime API Key는 NAME을 WAKATIME_APIKEY로 설정한 뒤 아까 위에서 가져온 Key값을 넣어준다.
다음엔 프로필 저장소 -> Actions -> set up a workflow yourself를 클릭한다.
name: Waka Readme
on:
schedule:
# Runs at 12am IST
- cron: '30 18 * * *'
# cron: '00 15 * * *'로 하면 한국 시간 기준으로 오전 12:00에 업데이트 된다
workflow_dispatch:
jobs:
update-readme:
name: Update Readme with Metrics
runs-on: ubuntu-latest
steps:
- uses: anmol098/waka-readme-stats@master
with:
WAKATIME_API_KEY: ${{ secrets.WAKATIME_API_KEY }}
GH_TOKEN: ${{ secrets.GH_TOKEN }}그러면 코드 작성란이 나올텐데 거기에 위 코드를 복사 + 붙여넣기 한다.
그러면 목록에 이런 것이 생성될 것이다. 새로 생성된 목록을 클릭해준다.
마지막으로 Run workflow를 눌러주고 업데이트가 완료되길 기다리면 된다.
추가
처음 설정했을 때는 Flag 설정이 대부분 True로 되어 있어서 원하지 않는 것도 표시가 될 것이다.
그러면 Flag 설정 참고 이 사이트로 들어가서 원하지 않는 Flag 옵션을 False로 설정해주면 된다.
Falg 옵션을 설정할 때는 아까의 코드에 추가해주면 된다.
예시
SHOW_COMMIT: False
SHOW_PROJECTS: False
SHOW_EDITORS: False
SHOW_LOC_CHART: False
SHOW_DAYS_OF_WEEK: False
SHOW_SHORT_INFO: False
SHOW_PROFILE_VIEWS: False
IGNORED_REPOS: False
SYMBOL_VERSION: 1
DEBUG_LOGGING: False최종적으로 완성된 프로필
마무리
일단은 기본적인 것들은 추가된 것 같다.
이제 나를 소개하는 문구를 좀 생각해서 적어보고 마무리하면 그래도 꽤 깔끔한 프로필이 나올 것 같다.
감사합니다. 😌
