🍺 오픈소스에 커밋 with homebrew-cask

Picture by Homebrew web page

이 글은 Notion 에서 작성한 페이지에서도 보실 수 있습니다

🙇‍♂️ 오픈소스에 커밋한다는 건...?

---

막연합니다. 어렵구요
설령 풀리퀘가 만에 하나 Merged 라도 되면

내 코드가 이걸 쓰는 사람들에게
바이러스처럼 번져 나갈 것입니다

부담도 되고 마치 짝사랑 처럼 퇴짜맞을까 겁도 납니다
그치만 개발자라면 해보고 싶은 어떤 '업적' 같은 거겠죠
"오픈소스에 커밋해본" 둔둔이 (칭호를 획득했다)

아직 제게는 그렇습니다
오타 수정이라도 해보고 싶은 그런 마음

🙅‍♂️ 답답하면 니들이 뛰든지

---

모든 일에는 원인과 결과가 있죠
'homebrew cask 에 커밋을 해보자' 라고 마음먹은 계기는 정말 사소했습니다

이 글 처럼 저는 homebrew 에 대한 큰 애정이 있습니다
그래서 모든 앱을 homebrew cask 로 설치할 수 있는 상황에서는
공식 홈페이지에서 앱을 다운로드 받지 않고 아래 처럼 설치합니다

이런 일이 일어날 것 같은 조짐을 느꼈지. 작동이 안되잖아 으아아아

안됩니다 안돼요 🙅‍♂️
지금으로부터 며칠 전부터 계속 저 상태입니다
답답합니다

당신은 대체 어디까지 보신겁니까...

진짜 설치하고 싶어요 근데 언제 누가 업데이트 해줄지 모르잖아요
dmg 파일을 받아 readme.rtf 파일을 열어보니, 벌써 2.5.5 버전까지 나왔습니다 😲

이제는 못 기다리겠습니다. 그래서 한 번 직접 해보려고 합니다

🎤그래서 어떻게 하면 되나요?

---

homebrew cask 에 커밋을 하는 과정은
아래의 순서대로 진행했습니다

커밋 가이드 읽기 → 코딩 → 테스트 → 풀 리퀘스트

homebrew cask의 커밋은 벌써 8만번이 넘었습니다
그 얘기는 무수히 많은 풀리퀘를 별 탈 없이 잘 처리하고 있다는 거겠죠

어떤 잘 정해진 약속만 따르면 문제 없을 것 같다는 생각이 듭니다
그럼 컨트리뷰터들을 위해 약속이 적혀있는 CONTRIBUTION.md 파일을 확인해 보겠습니다

⚠️ CONTRIBUTION.md

---

(homebrew cask 의 CONTRIBUTION.md 파일은 여기서 직접 확인할 수 있습니다)

모든 글을 함께 읽고 생각하면 좋겠지만, 여러분들의 영어가 저보다 낫다는 생각을 합니다
아래는 CONTRIBUTION.md 파일의 머릿말 입니다

How To Contribute
👍🎉 First off, thanks for taking the time to contribute! 🎉👍

• Updating a Cask
• Getting Set Up To Contribute
• Adding a Cask
• Style guide
• Reporting Bugs

환영받는 기분 이네요
엄청나게 많은 cask의 버전을 모두가 같이 관리 한다는건
환영 받을만한 일인 것 같습니다!

일단 큰 주제를 보면
Updating a Cask → 아직 업데이트를 안해서 cask 버전이 낮을 수 있어 한 번 업데이트 해보렴
Getting Set Up To Contribute → 컨트리뷰트 하기 위한 준비
Adding a Cask → cask 를 추가하는 경우일 듯 (저는 버전 업그레이드가 필요하기 때문에 패스)
Style guide → 스타일 가이드가 있네요. 안 지키면 reject 될 것 같으니 읽어 봐야겠습니다
Reporting Bugs → 아직 버그를 만난 적 없으니 일단 버그를 마주치면 고민해봐요

5개 정도가 있는데요
cask 버전 업그레이드를 위해서는 컨트리뷰트가 필수적이니
컨트리뷰트를 하기 위한 준비 과정부터 시작합니다

🐙 Git works

---

친절한 설명이 문서에 있습니다
(잠깐 딴 소리지만 역시 개발자는 문서를 잘 읽어야 합니다. 개발 문서나 기획 문서나 계약서나...)

For manual updates, you'll need to fork the repository and add your copy as a remote (can also be done with hub fork).

1: Fork the repository in GitHub with the Fork button.
→ 이 저장소를 Fork 버튼으로 포크를 꾹 찍습니다

2: If you have not already done so, add your GitHub fork as a remote for your homebrew-cask Tap:
→ 아직 포크를 안했으면, 포크를 하고 아래와 같이 프로젝트 디렉토리로 이동해 원격 저장소 주소를 등록합니다

$ github_user='<my-github-username>'
$ cd "$(brew --repository)"/Library/Taps/Homebrew/homebrew-cask
$ git remote add "${github_user}" "https://github.com/${github_user}/homebrew-cask"

3: If you have already added your GitHub fork as a remote for your homebrew-cask Tap, ensure your fork is up-to-date.
→ 만약 이미 포크를 하고, 원격 저장소 주소 또한 등록했다면, pull을 받아서 최신 버전으로 갱신합니다

4: Switch to a new branch (ie. new-feature), and work from there: git checkout -b new-feature.
→ 새 브랜치를 만들고, 그 곳에서 작업합니다

브랜치 이름은 딱히 관계 없는 듯 하지만
그래도 뭔가 맞춰야 할 것 같아서 다른 사람들의 커밋을 뒤져보았습니다

대략적인 규칙은 이렇습니다

1. {github_user_name}:cask_repair_update-{cask_name}
2. {github_user_name}-{cask_name}-{new_version}

브랜치 작업이 완료 되었으니, 실제로 버전을 바꿔보도록 하죠

⚔️ Code Works

---

제가 수정해야 할 ridibooks 의 cask 파일은
Casks/ridibooks.rb 에 있습니다

파일을 열면 이런 코드가 보입니다
(현재는 제 Pull Request 가 합쳐져 brew update 를 한 상태라면, 2.5.5로 보일 수 있습니다)

# 여기 부터 아래의 값들은 모두 순서적 의미가 있습니다 stanzas 라는 불리는 필드 들이 순서대로 배치되어야 합니다
cask 'ridibooks' do 
  version '2.5.3' # 버전과
  sha256 '51020bb7d36ed6af245591d6a653aa1d5d253ed9203598d87857059669b553d3' # 새 버전의 파일의 checksum 값을 바꿔주면 될 것 같습니다

  url "https://viewer-ota.ridibooks.com/mac/ridibooks-#{version}.dmg" # 다운로드 url 이 변경되지는 않았는지 확인도 필요합니다
  name 'Ridibooks' # Cask를 대표하는 이름 입니다. 굳이 수정할 필요는 없을 듯 합니다
  homepage 'https://ridibooks.com/support/app/download' # Cask 소프트웨어를 만든 vendor의 다운로드 웹 페이지 입니다

  app 'Ridibooks.app' # .dmg 파일을 설치 했을 때의 이름과 확장자 입니다.

  zap trash: [
               '~/Library/Application Support/RIDI',
               '~/Library/Preferences/com.ridibooks.Ridibooks.plist',
             ]
end

(주석을 읽어 보시면, 다른 Cask의 버전 업그레이드를 하실 때 도움이 될 수 있습니다)

제 생각에는, 버전과 sha256 checksum 값만 변경 해주면 될 것 같습니다

1. 버전 확인

   방법이 있나요? 공식 홈페이지에서 직접 dmg 파일을 받아 보아야 알 수 있습니다
   
   받아 보니 현재는 2.5.5 버전 이네요 그리고 잡다한 이미지 파일들...

2. sha256 checksum 확인

   curl 을 이용해 다운로드 URL 이 유효한지 확인할 겸
   #{version} 으로 된 부분에 2.5.5를 대입하여 다운로드를 해 봅니다

   $ curl -O https://viewer-ota.ridibooks.com/mac/ridibooks-2.5.5.dmg # 대문자 O(오) 입니다

   잘 받아 졌으면, dmg 파일로 직접 설치도 해 봅니다.
   
   설치하고 동작시켜서 이상이 없으면, 정상적인 파일이라고 간주 하겠습니다

   참고로, sha256 checksum은 MacOS 에서 아래와 같이 확인합니다

   $ shasum -a 256 ridibooks-2.5.5.dmg
   3cca39ed89f768cbd2f8b8f28240c271ea4e4927f8a7133fe13999ddc629f5c6  ridibooks-2.5.5.dmg

지금 까지 저는 아래 3가지 동작을 확인했어요

• 최신 버전 확인
• 다운로드 URL의 유효성 확인
• SHA256 checksum 확인

이제 슬슬 커밋하고, Pull Request를 넣어 볼 차례입니다

🧪 Test! Test!

---

제가 아는 오픈 소스는 대부분 커밋 전에 테스트를 통해
새로 추가/변경될 코드의 동작을 보장합니다

물론 homebrew cask 에도 테스트가 있습니다
이 곳의 문서 내용에 따르면, 아래 두 명령어를 통해 테스트를 해볼 것을 권장합니다

$ brew cask audit my-new-cask --download

$ cd "$(brew --repository)"/Library/Taps/Homebrew/homebrew-cask
$ brew cask style Casks/my-new-cask.rb [--fix]

첫 번째는 새로 변경한 내 cask가 다운로드 되어 잘 작동 하는지 검사하는 것
두 번째는 새로 변경한 .rb 파일의 스타일이 코딩 컨벤션을 잘 따르는지 확인하는 것 입니다

그럼 audit 먼저 실행해 보겠습니다

passed 의 녹색불이 주는 안정감이란... 퍄퍄

새로 변경한 버전으로 잘 다운로드 되고, SHA-256 checksum 확인도 통과했습니다
이어서 style 을 확인해볼게요

동작이 안돼 으아아아

잉? 안되네요...
스타일 확인해야 되는데 😭 큰일입니다
부랴부랴 이슈를 뒤져보다 보니 이런 코멘트 를 발견합니다

Care to try brew vendor-install ruby?
Solved some issues for me regarding jaro_winkler.

역시 세상은 넓고 능력자는 많습니다
심지어 공식 솔루션이 되어 해당 이슈는 현재 closed 된 상태입니다

brew vendor-install ruby 를 실행하고 다시 style 검사를 해볼게요

먼저 해결책 대로 brew vendor-install ruby 실행

2s on 🌵 master
⚡ 100% in homebrew-cask 🐶 doondoony ✘ 1 λ  brew vendor-install ruby
==> Downloading https://homebrew.bintray.com/bottles-portable-ruby/portable-ruby-2.3.7.leopard_64.bottle.tar.gz
######################################################################## 100.0%
==> Pouring portable-ruby-2.3.7.leopard_64.bottle.tar.gz

그리고 짜잔 통과했습니다

no offenses detected 라는 메시지를 보니 이전에 malware 같은걸 커밋한 적도 있나 봅니다

이제 진짜진짜 커밋할 준비를 마친 듯 합니다
✨ Pull Request ✨ 를 할 시간 입니다

🐙 Git works again

---

새로 생성한 브랜치를 제 원격 저장소 (저의 경우 DoonDoony) 의 브랜치로 push 해야 합니다
그걸 하기 위해 커밋을 해야 하는데, 어쩐지 커밋 메시지도 컨벤션이 있을 듯 합니다

한 번 기존의 커밋 로그를 살펴볼게요

저기 어딘가에 이미 Merged 인 제가 있군요 헤헤호호

보통 커밋 메시지를 Update {cask name} to {업데이트 된 버전} 으로 남기네요! 참고합니다

$ git add -p  # 바뀐 내용 한 번 더 확인
$ git commit -m "Update ridibooks to 2.5.5"  # 규칙대로 커밋 메시지 작성
$ git checkout master  # 작업중인 브랜치에서 마스터로 체크아웃
$ git push -u DoonDoony DoonDoony-ridibooks2.5.5  # 제가 작업한 브랜치명은 이랬습니다

git push -u 명령어에 대한 설명은 링크로 대체 합니다
대충 설명드리면 원격 저장소에는 아직 DoonDoony-ridibooks2.5.5 라는 브랜치가 없는데
로컬 저장소의 브랜치를 push 하면서 원격 저장소에 브랜치도 생성되게 해 줍니다
(사실 upstream 으로 만들고 하는 뭔가의 내부 동작이 있습니다)

그럼 이제 진짜 Pull Request 를 해볼까요 (아직도 못함)

⛑ Pull Request 와 통과 의례 ~ Travis CI ~

---

Pull Request 는 아래 그림에서 보이는 Pull requests 탭에서 합니다

탭에 들어 가면, 만약 방금 커밋을 마친 상태라면 아래 처럼 자동으로 표시됩니다
그렇지 않다면 New pull request 버튼을 눌러 새 pull request 를 합니다

아래 이미지에 있는 것과 같이 체크박스에 있는 내용을 수행해야 합니다
(After making all 어쩌구 하는 부분 아래 네 가지 항목입니다)

내용은 아까 제가 위에서 이미 진행했던 것들 입니다

• brew cask audit
• brew cask style —fix
• 커밋 메시지는 이렇게 쓸 것
• 제출하는 것이 stable 버전의 어플리케이션이 맞는지

이미 했지만 그래도 잘 살펴가며 네 가지 항목을 확인해서 '[x]' 로 만들어 줍니다
저는 새로운 cask 를 만든게 아니므로 아래의 체크 항목은 지우겠습니다

이제 실제로 Pull Request 가 진행됩니다
실제 homebrew-cask 레포의 하나의 Pull requests 로 검토를 거쳐 등록될 예정입니다

제가 이걸로 글을 쓸 생각을 안하다 보니 Travis CI 가 테스트를 하는 걸 찍지 못했습니다

저는 CI/CD 도구가 어떻게 동작하는지 몰랐었는데요
휴대폰으로도 실시간으로 테스트가 동작하는 작업을 볼 수 있어서 신선했습니다
(테스트는 로컬에서 진행한것과 비슷한 것을 합니다. audit, 실제로 설치해보고 동작 확인 등)

여담이지만, 저는 테스트를 통과해서 어떨지 모르지만
만약에 테스트를 통과 못하면 애초에 Reject 되는지는 확실하지 않습니다

🍷 기다림의 시간

---

무언가 잘못되어서 Reject 가 될 수 도 있고
관리자가 문제가 있어 코멘트를 남길 수도 있습니다

보통의 경우 앱의 단순한 버전 업데이트는 금방 처리되는 것 같습니다
(저의 경우에는 약 12시간 정도 소요되었습니다)

만약 거절 되었다면
다른 사람들의 커밋이나 받은 피드백을 통해 다시 시도 해보시면 되겠죠!

✨ 느낀 점

---

쭉 보시니까 어떤가요? 코드 한 줄 짜지 않고
뭔가 오픈소스에 커밋을 하긴 했습니다

저는 개인적으로 업적 (칭호) 을 떠나
남이 해주길 기다리지 않고, 능동적으로 불편함을 해소 했다는 점에서

그리고 누군가는 homebrew cask 로 리디북스 뷰어를 설치하면서
아 왜 안되지 하고 계시다가 "어 이제 된다 😲" 하지 않으셨을까 하는

그런 만족감을 얻을 수 있었습니다

그리고 코드의 안정성은 정말 테스트에서 오는구나 하는 테스트의 중요성
협업을 할 때는 룰을 지키는 것 만큼 중요한 것이 없다는 것

다양한 경험을 짧은 시간을 통해 얻을 수 있었습니다
(실제로 Pull Request 를 하는데 까지 약 한시간 정도 밖에 걸리지 않았습니다)

정말 작은 한 발 이지만
언젠가는 제가 즐겨 사용하는 오픈소스 소프트웨어에도
기여를 할 수 있게 해주는 첫 걸음인 것 같아 뜻 깊은 경험이었습니다

항상 조언과 잘못된 정보 제보, 오타 지적은 환영합니다
여기 까지 읽어 주셔서 감사합니다 🐶