jargons.dev 빌드 [# 포크 스크립트

이것은 시스템 아키텍처에 명시된 대로 작성하기로 한 4개의 스크립트 중 첫 번째입니다. 펌핑되는 느낌! GitHub UI와 인터페이스하지 않고 오픈 소스에 기여하는 "wiki" 경험을 만드는 방향으로 나아가는 단계였습니다.

이 스크립트는 무엇입니까?

이는 특히 GitHub API와 상호작용하는 데 사용되는 재사용 가능한 관련 기능을 포함하는 js 파일입니다. 동일한 스크립트 내에서 사용되거나 프로젝트 내의 다른 곳에서 기본 기능을 수행하는 데 사용되도록 내보내집니다. 사용자의 인증된 Octokit 인스턴스를 다른 매개변수로 받아들이며, 이 인스턴스는 인증된 사용자를 대신하여 GitHub API를 통해 작업/기능을 수행하는 데 사용됩니다.

GitHub UI와 인터페이스하지 않고 오픈 소스에 기여하는 흐름을 만들어야 한다는 것은 일부 프로세스를 자동화해야 한다는 것을 의미했습니다. 사용자가 GitHub UI를 통해 기여하려는 경우 수행할 모든 단계를 시뮬레이션하는 단계는 다음과 같습니다. 팔로우합니다..

1. 포크 프로젝트 레포
2. 브랜치 만들기
3. 브랜치에 변경 사항 커밋(새 단어에 대해 src/pages/word/ 디렉터리에 새 mdx 파일을 추가하거나 이 경우 기존 단어 편집)
4. Pull Request 만들기(여기서는 변경된 단어 제출)

말할 가치가 있는 진실

저는 초기 커밋 직후에 이 스크립트를 작성하기 시작했습니다. 사실 이것은 PR #2였지만 긴 한 달의 휴식 기간 동안 히트를 쳤습니다. 기본 사전 기능 작업에 다시 참여하기 전에 프로젝트에서 가져왔습니다.

스크립트

여기서 작업은 "포크 스크립트"를 생성하는 것이었습니다. 이 스크립트의 최종 목표는 사용자 계정에서 jargons.dev 저장소의 포크를 생성/가져오는 것입니다. 다음을 수행하는 모든 기능을 수용해야 합니다.

• jargons.dev의 포크가 사용자 계정에 이미 존재하는지 확인하세요.
  • 포크가 존재하는 경우
    • 포크가 업스트림과 동기화되어 있는지 확인하세요(즉, jargons.dev 저장소 기본 브랜치와 최신 상태인지 확인하세요). 그렇지 않은 경우 — 포크를 업데이트하세요
  • 포크가 발견되지 않은 경우
    • 포크 만들기

과제를 이해하고 바로 대본 작업에 들어갔습니다.

저는 Hearts ❤️에 대한 일상적인 작업에서 자주 사용하기 때문에 이미 GitHub API에 매우 익숙합니다.... 그래서 GitHub의 Fork 문서가 제 눈에는 브로스키처럼 보이더군요 ?...

단계

• 포크 기능을 실행하기 위한 주요 진입점인 기본 forkRepository 함수를 만들었습니다. 이 함수는 다른 모든 곳으로 연결됩니다
• 주로 명백한 기본 forkRepository 함수에 도우미 역할을 하는 다음 함수를 추가했습니다.
  • isRepositoryForked - 이 함수는 jargons.dev 저장소가 현재 인증된 사용자 계정으로 이미 포크되었는지 확인합니다.
  • isRepositoryForkUpdated - 포크(발견된 경우)가 (헤드 저장소와 동기화) 기본 jargons.dev 저장소와 최신 상태인지 확인합니다
  • updateRepositoryFork - 저장소를 기본(헤드) jargons.dev 저장소의 상태로 업데이트(동기화)하는 데 사용됩니다
  • getBranch - 기본 기능을 수행하기 위해 isRepositoryForkUpdated 도우미에서 수행되는 비교에 사용할 jargons.dev 저장소 및 사용자 포크에 대한 Branch/Ref 세부 정보를 가져오는 데 사용되는 기본 유틸리티(이 스크립트 작성 시점에 필요)입니다. GitHub References 엔드포인트를 사용합니다.

내 이상한 가정

내 마음 속을 달리고 있나요? 이 스크립트를 쓰면서 GitHub Fork Documentation에서 아래 인용된 단락을 읽은 후 마음에 품은 생각이 있었습니다

참고: 저장소 포크는 비동기적으로 발생합니다. Git 개체에 액세스하려면 잠시 기다려야 할 수도 있습니다. 5분 이상 소요되면 반드시 GitHub 지원팀에 문의하세요.

저는 이것을 오해하여 포크 프로세스만 시작할 수 있을 뿐이고 계속 진행하면 새 포크의 세부 정보를 반환하는 응답 객체를 기다릴 수 없을 것이라고 가정했습니다. 왜냐하면 우리는 모르기 때문입니다. 포크 프로세스가 완료되면.

이 가정으로 인해 메인 forkRepository 함수에서 어떤 데이터도 반환하지 않게 되었고 저는 이미 이 시점에서 생각하기 시작했습니다. 기여 프로세스의 다음 단계에서 처리할 포크 세부 정보를 어떻게 얻을 수 있을까요? 흠, 어쩌면 웹훅을 사용할지도?!?

내가 너무 생각하고 있었다는 사실이 밝혀졌습니다. 나중에 포크에 대한 응답 세부 정보를 얻게 될 것이라는 사실을 깨달았고 이로 인해 포크 응답 개체에서 소비하기 위해 필요한 데이터를 반환하는 문제를 해결하기 위한 후속 PR을 수행하게 되었습니다. 기부 과정

홍보

메인:

특기: `fork` 저장소 스크립트 구현 #3

바블비 게시일: 2023년 12월 31일

이 Pull Request는 포크 스크립트를 구현합니다. 이 스크립트는 프로그래밍 방식으로 기본 프로젝트 저장소를 사용자 계정으로 포크하는 데 사용됩니다. 여기에는 효율적인 저장소 포크 작업을 보장하기 위해 필요한 작업을 수행하는 데 사용하는 기본 기능과 기타 도우미 기능이 포함되어 있습니다.

변경사항

• 스크립트 내에서 기본 forkRepository 기능을 구현했습니다. 이 함수는 기본 포크 작업을 수행하는 기본 내보내기 함수입니다. userOctokit(사용자를 대신하여 작업할 수 있는 권한이 있는 사용자 인증 개체) 인스턴스와 프로젝트 저장소 세부 정보(예: repoDetails 개체)를 허용하고 다음을 수행합니다.
  • isRepositoryForked 도우미 함수를 사용하여 프로젝트 저장소가 이미 사용자 계정으로 포크되었는지 확인합니다. 이것은 null 포크를 반환합니다
    • 저장소가 이미 포크된 경우 isRepositoryForkUpdated 도우미 함수를 사용하여 포크가 최신 상태인지/메인 프로젝트 저장소와 동기화되어 있는지 확인합니다. 이는 업데이트된 SHA와 포크가 최신인지 확인하는 부울 isUpdated 속성을 반환합니다.
      • 포크가 최신이 아닌 경우; 그런 다음 updateRepositoryFork 도우미 함수를 사용하여 기본 프로젝트 저장소와 동기화하여 업데이트를 수행합니다
    • 저장소가 최신 상태이거나 기본 프로젝트 저장소와 동기화된 경우 이 시점에서 조기 반납으로 운영을 중단합니다.
  • 프로젝트 저장소가 사용자 계정으로 분기되지 않은 경우 그런 다음 userOctokit 인스턴스를 사용하여 "POST /repos/{owner}/{repo}/forks" 엔드포인트를 호출하여 포크 프로세스를 시작합니다. (이것은 포크 프로세스를 시작합니다. 프로세스가 언제 완료되는지 정확히 알 수 없습니다 ?)
• 기본 forkRepository 함수와 다른 도우미 함수 내에서 사용되는 다음 도우미 함수를 구현하세요.
  • updateRepositoryFork - 저장소를 기본(헤드) 저장소의 상태로 업데이트(동기화)하는 데 사용됩니다
  • isRepositoryForkUpdated - 포크가 (헤드 저장소와 동기화되어) 기본 저장소와 최신 상태인지 확인하는 데 사용됩니다
  • getBranch - Branch/Ref 세부정보를 가져오는 데 사용됩니다
  • isRepositoryForked - 사용자의 포크 저장소 목록에 특정 저장소가 있는지 확인하는 데 사용됩니다
• /lib/utils에 getRepoParts를 추가했습니다. 저장소 전체 이름에서 repoOwner 및 repoName을 확인하는 데 사용되는 유틸리티 함수입니다.

관련사항

2번 해결

스크린캐스트/스크린샷

https://github.com/babblebey/jargons.dev/assets/25631971/16221b7e-3c28-4c6c-a1f3-24d583ce7e3a

?

GitHub에서 보기

후속 조치:

feat: 포크 스크립트에서 repo `fullname` 반환 #29

바블비 게시일: 2024년 4월 4일

이 PR은 #3의 포크 스크립트 초기 구현에서 누락된 단계에 대한 후속 조치입니다. 포크 스크립트가 다음 계산 단계에서 사용할 수 있는 저장소를 반환하지 못했습니다. 이는 초기 구현 중에 가졌던 이상한 가정 때문이었습니다. ?아래 내 가정을 참조하세요...

"POST /repos/{owner}/{repo}/forks" 엔드포인트에 대한 호출은 응답을 전혀 보장하지 않고 포크 프로세스 시작만 보장한다고 가정합니다. 즉, 호출 후에 response.data를 정확하게 얻지 못할 수도 있습니다

...하지만 그건 사실이 아니었습니다. 실제로 response.data가 온다는 것을 알았지만 시간이 좀 걸릴 수도 있고 포크되는 저장소가 큰 경우에만.... 그리고 지금은 프로젝트 저장소 포크는 5초 이내에 이루어집니다.

변경사항

• 반환된 포크 저장소 - isRepositoryForked 도우미 함수에서 반환된 저장소 전체 이름 값입니다. 이로써 실행 중인 사용자 계정에서 repo가 ​​이미 포크된 조건에서 forkRepository 함수 실행의 기본 반환 값으로 반환합니다
• 반환된 response.data.full_name - 새로 생성된 포크 저장소 전체 이름입니다. "POST /repos/{owner}/{repo}/forks" 엔드포인트 호출에 대한 응답의 값입니다. 실행 중인 사용자 계정에서 이미 포크가 발견되지 않은 경우 이를 forkRepository 함수 실행에서 기본 반환 값으로 반환합니다
• Cherry는 #25에서 여기에 사용할 몇 가지 변경 사항을 선택했습니다.
  • f12f25f548a5c5836e9be7d601ed226c5269f5ee
  • 436ceea649b67812c0ec1164fde95d443ce556e0

?

GitHub에서 보기

위 내용은 jargons.dev 빌드 [# 포크 스크립트의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!