Skip to content

docs: 벤더링 절차 — 엔진 SHA를 7자리로 - #41

Merged
onetwothr1 merged 2 commits into
devfrom
docs/vendor-sha-short
Aug 3, 2026
Merged

docs: 벤더링 절차 — 엔진 SHA를 7자리로#41
onetwothr1 merged 2 commits into
devfrom
docs/vendor-sha-short

Conversation

@onetwothr1

@onetwothr1 onetwothr1 commented Aug 3, 2026

Copy link
Copy Markdown
Collaborator

docs/fig-extract-integration.md §갱신 절차의 SHA 표기를 40자 전체 → 7자리로 바꿉니다. 문서 한 파일, 4줄 변경입니다.

추적에 필요한 것은 "어느 커밋을 복사했나"이고 이 저장소 규모에서 7자리면 충분히 유일합니다. 충돌하면 git이 더 긴 약칭을 요구하므로 그때 늘리면 됩니다. 2단계의 rev-parse HEADrev-parse --short HEAD로 맞췄습니다.

배경

직전 v2.26.1 벤더링(#40)에서 CI가 test/fig-engine.test.ts의 버전 핀 불일치를 잡았습니다 — VENDORED_ENGINE_VERSION을 안 올린 채 엔진 파일만 복사한 상태였습니다.

원인은 엔진 repo의 축약본(docs/PLAYBOOKS.md §PB-5)에 이 문서 §갱신 절차의 세 단계가 빠져 있던 것입니다.

  • VENDORED_ENGINE_VERSION을 같은 커밋에서 갱신 (계약 태그와 무관하게 매번)
  • npm test (PB-5에는 typecheck && build만 있었습니다 — 그 둘은 이 결함을 통과시키고 테스트만 잡습니다)
  • ⑧ 커밋 메시지에 엔진 SHA 명시

엔진 repo 쪽 PB-5는 이 문서를 정본으로 삼아 8단계로 맞추는 수정을 함께 올립니다. 이 PR은 그중 SHA 표기 규칙만 정본에 반영하는 것입니다.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • 문서
    • 엔진 업데이트 절차에서 커밋 SHA를 7자리 약칭 형식으로 기록하도록 안내를 수정했습니다.
    • 커밋 메시지에 복사한 엔진의 7자리 SHA를 포함하는 예시와 설명을 업데이트했습니다.

전체 40자를 적을 필요가 없다. 추적에 필요한 것은 "어느 커밋을 복사했나"이고
이 저장소 규모에서 7자리면 충분히 유일하다 (충돌하면 git이 더 긴 약칭을
요구하므로 그때 늘리면 된다). 2단계의 rev-parse HEAD도 --short로 바꾼다.

엔진 repo 쪽 축약본(PLAYBOOKS.md §PB-5)도 같은 값으로 맞춘다 — 이번 v2.26.1
벤더링에서 그 축약본에 VENDORED_ENGINE_VERSION 갱신 · npm test · SHA 명시
세 단계가 빠져 있어 CI가 버전 핀 불일치를 잡았다.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@onetwothr1
onetwothr1 requested a review from enu3379 as a code owner August 3, 2026 13:07
@coderabbitai

coderabbitai Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Warning

Review limit reached

@onetwothr1, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 38 minutes

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 42dc1027-62a6-4c2a-804c-a717aa68a267

📥 Commits

Reviewing files that changed from the base of the PR and between b6e17bc and 78bc403.

📒 Files selected for processing (1)
  • docs/fig-extract-integration.md
📝 Walkthrough

Walkthrough

엔진 업데이트 절차에서 기록하는 커밋 SHA를 전체 SHA에서 7자리 약칭 SHA로 변경했다. 커밋 메시지 안내에는 7자리 SHA를 기본값으로 사용하고, 충돌 시 더 긴 약칭을 사용하도록 명시했다.

Changes

엔진 SHA 문서 갱신

Layer / File(s) Summary
7자리 SHA 기록 안내
docs/fig-extract-integration.md
엔진 커밋 기록에 rev-parse --short HEAD를 사용한다. 커밋 메시지 예시와 충돌 시 처리 규칙을 7자리 SHA 기준으로 갱신했다.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related PRs

  • enu3379/PDFViewer#3: 동일한 문서의 엔진 업데이트 절차와 커밋 메시지 안내를 수정했다.
  • enu3379/PDFViewer#40: 엔진 버전 업데이트와 7자리 SHA 기록이 직접 관련된다.

Suggested reviewers: enu3379

Poem

나는 토끼, 짧은 SHA를 기록해요.
일곱 칸이면 엔진을 찾을 수 있어요.
충돌이 오면 더 길게 적고,
커밋 메시지도 또렷해져요.
깡충, 문서 갱신 완료!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed 제목은 문서의 엔진 SHA 표기를 7자리로 변경하는 주요 내용을 정확하고 간결하게 설명합니다.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/vendor-sha-short

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/fig-extract-integration.md`:
- Line 230: Update the git rev-parse command in the SHA-recording instruction to
use the explicit --short=7 option, preserving the documented seven-character SHA
requirement while allowing Git to extend the abbreviation only when collision
resolution requires it.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 6862ad27-3d9c-4993-b614-3b446e0b5392

📥 Commits

Reviewing files that changed from the base of the PR and between 3eda1f7 and b6e17bc.

📒 Files selected for processing (1)
  • docs/fig-extract-integration.md

Comment thread docs/fig-extract-integration.md Outdated
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@onetwothr1
onetwothr1 merged commit 80f53b3 into dev Aug 3, 2026
3 checks passed
@onetwothr1
onetwothr1 deleted the docs/vendor-sha-short branch August 3, 2026 13:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant