Skip to content

chore: 운영 문서 docs 하위 이동#620

Merged
Hyeonjun0527 merged 1 commit into
developfrom
chore/docs-ops-move-develop
May 18, 2026
Merged

chore: 운영 문서 docs 하위 이동#620
Hyeonjun0527 merged 1 commit into
developfrom
chore/docs-ops-move-develop

Conversation

@Hyeonjun0527

@Hyeonjun0527 Hyeonjun0527 commented May 18, 2026

Copy link
Copy Markdown
Member

요약

  • 운영 배포 문서를 docs/ops로 정리하고 온보딩/상세 가이드/공유 계약 구조로 단순화했습니다.
  • 운영 배포 설명을 백엔드 먼저 확인 → 프론트 배포 → 최종 릴리즈 기록 확인 흐름으로 정리했습니다.
  • Codex/Claude skill wrapper가 skills_context/SHARED/zeroone-version-management.md를 보도록 경로를 정리했습니다.

검증

  • ruby -e "require 'yaml'; YAML.load_file('.github/workflows/deploy-prod.yml'); YAML.load_file('.github/workflows/release-record-check.yml'); puts 'workflow yaml ok'"\n- node scripts/release/validate-release-record.mjs releases\n- git diff --check HEAD^..HEAD\n- push hook next build 통과

Summary by CodeRabbit

릴리스 노트

  • 문서화

    • 운영 배포 절차 및 릴리즈 관리 문서를 새로 추가하여 배포 흐름을 통합 정리했습니다.
    • 프론트엔드 및 백엔드 간 릴리즈 기록 공유 계약을 명시하는 문서를 추가했습니다.
    • 레거시 인증 리팩토링 관련 문서를 정리하고 운영 문서 구조를 재정렬했습니다.
  • 구성 개선

    • 배포 워크플로우 경로 필터를 업데이트했습니다.
    • 에이전트 스킬 참조 경로를 통합하여 관리 효율성을 개선했습니다.

Review Change Stack

Co-authored-by: OmX <omx@oh-my-codex.dev>
@vercel

vercel Bot commented May 18, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
study-platform-client-dev Building Building Preview, Comment May 18, 2026 10:56am

@coderabbitai

coderabbitai Bot commented May 18, 2026

Copy link
Copy Markdown
📝 Walkthrough

Walkthrough

버전 관리 운영 문서를 ops/*에서 docs/ops/*로 이전하면서 모든 참조 경로를 갱신하고, 배포 절차와 FE/BE 릴리즈 기록 공유 계약을 정의하는 새로운 종합 문서들을 추가합니다.

Changes

Version Management Documentation Reorganization

Layer / File(s) Summary
Configuration, skill, and workflow reference migration
.claude/rules/version-management-frontend.md, .claude/skills/zeroone-version-management/SKILL.md, .codex/skills/zeroone-version-management/SKILL.md, .github/workflows/deploy-prod.yml, .github/workflows/release-record-check.yml, AGENTS.md, skills_context/SHARED/zeroone-version-management.md
모든 설정 파일, Claude/Codex 에이전트 스킬, GitHub 워크플로우가 버전 관리 문서 참조를 ops/version-management.md에서 docs/ops/version-management.md로 변경하고, 에이전트 스킬 SSOT가 ops/agent-skills/zeroone-version-management.md에서 skills_context/SHARED/zeroone-version-management.md로 이동합니다. deploy-prod 워크플로우 경로 필터도 ops/**에서 docs/ops/**로 변경되어 운영 배포 관련 변경이 워크플로우 실행 대상이 됩니다.
Release record shared contract specification
docs/ops/release-record-shared-contract.md
백엔드와 프론트엔드 간 운영 릴리즈 기록 공유 계약을 정의하는 문서로, repository_dispatch 이벤트의 payload 스키마, 최종 releases/<release_id>.yaml 기록 형식, 원자적 변경 규칙(backend-only, frontend-only, paired FE/BE), 검증 실패 조건, 그리고 첫 프로덕션 릴리즈를 위한 bootstrap 모드 예외 조건을 명시합니다.
Operational onboarding and procedures guide
docs/ops/onboarding.md, docs/ops/version-management.md
처음 운영 배포를 수행하는 사용자를 위한 온보딩 문서와 운영 절차 전체를 정리한 종합 가이드를 추가합니다. 백엔드/프론트엔드 배포 흐름, release intent 라벨 규칙, release_id 포맷, 이미지 태그 정책, 배포 전후 체크리스트, 실패/중복 방지 규칙, 롤백 절차, DB 호환성 제약을 포함합니다.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

  • code-zero-to-one/study-platform-client#611: 동일한 GitHub 워크플로우 path-ignore와 paths 필터를 ops/**에서 docs/ops/**로 변경하는 릴리즈 버전 관리 자동화 경로 업데이트를 포함합니다.

Poem

🐰 문서가 제자리 찾았네,

docs/ops로 모여 앉아,

배포 규칙 한곳에 정리하고,

FE와 BE가 손잡으며,

릴리즈가 더욱 똑똑해졌어요. 🚀

🚥 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 PR 제목이 주요 변경사항을 명확하게 설명합니다. 운영 문서를 docs 하위로 이동하는 것이 이 PR의 핵심이며, 제목이 이를 직접적으로 반영합니다.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/docs-ops-move-develop

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 and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 3

🧹 Nitpick comments (1)
skills_context/SHARED/zeroone-version-management.md (1)

19-21: ⚡ Quick win

읽기 순서 목록에서 문서 항목 중복을 제거해 주세요.

Line 9-11에서 이미 docs/ops/* 3개를 필수 선행 읽기로 정의했는데, Line 19-21에 다시 반복되어 “docs 먼저, 그 다음 scripts/workflows” 규칙이 흐려집니다. 하위 목록에서는 스크립트/워크플로우만 남기는 쪽이 명확합니다.

🤖 Prompt for 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.

In `@skills_context/SHARED/zeroone-version-management.md` around lines 19 - 21,
문서의 읽기 순서 목록에서 중복된 항목을 제거하세요: 현재 하위 목록에 다시 나열된 `docs/ops/onboarding.md`,
`docs/ops/version-management.md`, `docs/ops/release-record-shared-contract.md`
항목을 삭제하고 하위 목록에는 스크립트/워크플로우 항목만 남기도록 수정해 `docs` 항목이 상위 목록(필수 선행 읽기)에서만 유지되게 하세요.
🤖 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/asdfasdf.md`:
- Line 1: 파일에 의미 없는 플레이스홀더 텍스트 'asdfasdfsa'가 들어가 있습니다; 해당 문자열을 삭제하거나 운영 문서로서 유효한
실제 내용(목적, 개요, 사용법 등)으로 교체하고, 문서가 프로젝트 문서 인덱스나 TOC에 링크되어 있으면 관련 참조(예: README/TOC
항목)를 함께 갱신하여 깨진 참조가 없도록 해 주세요.

In `@docs/ops/release-record-shared-contract.md`:
- Around line 290-298: 문서에서 사용 중인 승인 토큰 표기 'bootstrap:approved'가 다른 SSOT 문서의
'bootstrap: approved'와 불일치하므로 하나로 통일해야 합니다; 문서 내 모든 언급(예: 문장 "백엔드는 ...
`bootstrap:approved` 승인을 받은 경우"와 프론트엔드 기록 예시 `metadata.bootstrap_mode: true`)을
찾아 SSOT에서 정한 표기('bootstrap: approved' 또는 SSOT에 명시된 정확한 공백 형식)로 일괄 교정하고, 문서 머리나
변경 이력에 어떤 표기를 표준으로 사용하는지 한 줄로 명시해 주세요.

In `@docs/ops/version-management.md`:
- Around line 61-65: The `release_id` is defined as a unique identifier but the
current format `prod-YYYYMMDD-HHmm` can collide for multiple releases inside the
same minute; update the `release_id` rule to include higher resolution (e.g.,
change `prod-YYYYMMDD-HHmm` to `prod-YYYYMMDD-HHmmss`) or append a deterministic
suffix/run number to guarantee uniqueness; update the docs text and examples to
show the new format and mention that `release_id` must be unique per deployment.

---

Nitpick comments:
In `@skills_context/SHARED/zeroone-version-management.md`:
- Around line 19-21: 문서의 읽기 순서 목록에서 중복된 항목을 제거하세요: 현재 하위 목록에 다시 나열된
`docs/ops/onboarding.md`, `docs/ops/version-management.md`,
`docs/ops/release-record-shared-contract.md` 항목을 삭제하고 하위 목록에는 스크립트/워크플로우 항목만
남기도록 수정해 `docs` 항목이 상위 목록(필수 선행 읽기)에서만 유지되게 하세요.
🪄 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: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: da88761a-ce84-4b1f-98b9-100459227ed9

📥 Commits

Reviewing files that changed from the base of the PR and between 70b1491 and 3cd2b38.

📒 Files selected for processing (32)
  • .claude/rules/version-management-frontend.md
  • .claude/skills/zeroone-version-management/SKILL.md
  • .codex/skills/zeroone-version-management/SKILL.md
  • .github/workflows/deploy-prod.yml
  • .github/workflows/release-record-check.yml
  • AGENTS.md
  • docs/2026-03-15-login-fail-fix/AUTH_STAGED_CHANGE_BREAKDOWN.md
  • docs/2026-03-15-login-fail-fix/FRONTEND_OAUTH_REDIRECTION_CONTRACT.md
  • docs/2026-03-15-login-fail-fix/MIDDLEWARE_AUTH_REFACTORING_NEXT_STEPS.md
  • docs/2026-03-15-login-fail-fix/MIDDLEWARE_ROUTE_POLICY_GUIDE.md
  • docs/2026-03-15-login-fail-fix/PR_AUTH_REFACTORING_OVERVIEW.md
  • docs/2026-03-15-login-fail-fix/SOCIAL_LOGIN_REFACTORING_PLAN.md
  • docs/2026-03-26-markdown-editor/COMMON_MARKDOWN_EDITOR_USAGE.md
  • docs/asdfasdf.md
  • docs/auth-proposition/AUTH_LOGICAL_PROPOSITIONS_200.md
  • docs/auth-proposition/AUTH_PROPOSITION_121_150_AUDIT.md
  • docs/auth-proposition/AUTH_PROPOSITION_151_180_AUDIT.md
  • docs/auth-proposition/AUTH_PROPOSITION_181_200_AUDIT.md
  • docs/auth-proposition/AUTH_PROPOSITION_1_30_AUDIT.md
  • docs/auth-proposition/AUTH_PROPOSITION_31_60_AUDIT.md
  • docs/auth-proposition/AUTH_PROPOSITION_61_90_AUDIT.md
  • docs/auth-proposition/AUTH_PROPOSITION_91_120_AUDIT.md
  • docs/ops/onboarding.md
  • docs/ops/release-record-shared-contract.md
  • docs/ops/version-management.md
  • ops/backend-release-dispatch.md
  • ops/deploy-checklist.md
  • ops/release-intent.md
  • ops/release-record-shared-contract.md
  • ops/rollback.md
  • ops/version-management.md
  • skills_context/SHARED/zeroone-version-management.md
💤 Files with no reviewable changes (13)
  • ops/deploy-checklist.md
  • docs/2026-03-15-login-fail-fix/MIDDLEWARE_ROUTE_POLICY_GUIDE.md
  • docs/2026-03-26-markdown-editor/COMMON_MARKDOWN_EDITOR_USAGE.md
  • ops/rollback.md
  • ops/version-management.md
  • docs/2026-03-15-login-fail-fix/PR_AUTH_REFACTORING_OVERVIEW.md
  • ops/release-intent.md
  • docs/2026-03-15-login-fail-fix/AUTH_STAGED_CHANGE_BREAKDOWN.md
  • docs/2026-03-15-login-fail-fix/MIDDLEWARE_AUTH_REFACTORING_NEXT_STEPS.md
  • ops/release-record-shared-contract.md
  • docs/2026-03-15-login-fail-fix/FRONTEND_OAUTH_REDIRECTION_CONTRACT.md
  • docs/2026-03-15-login-fail-fix/SOCIAL_LOGIN_REFACTORING_PLAN.md
  • ops/backend-release-dispatch.md

Comment thread docs/asdfasdf.md
@@ -0,0 +1 @@
asdfasdfsa No newline at end of file

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

의미 없는 플레이스홀더 텍스트가 문서로 추가되었습니다.

Line 1의 asdfasdfsa는 운영 문서로서 유효한 내용이 아니어서, 이 파일은 PR에서 제거하거나 실제 문서 내용으로 교체해 주세요.

🤖 Prompt for 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.

In `@docs/asdfasdf.md` at line 1, 파일에 의미 없는 플레이스홀더 텍스트 'asdfasdfsa'가 들어가 있습니다; 해당
문자열을 삭제하거나 운영 문서로서 유효한 실제 내용(목적, 개요, 사용법 등)으로 교체하고, 문서가 프로젝트 문서 인덱스나 TOC에 링크되어
있으면 관련 참조(예: README/TOC 항목)를 함께 갱신하여 깨진 참조가 없도록 해 주세요.

Comment on lines +290 to +298
현재 운영이 아직 canonical image tag 위에 있지 않다면, 백엔드는 백엔드 쪽에서 명시적인 `bootstrap:approved` 승인을 받은 경우에만 bootstrap mode를 사용할 수 있습니다.

Bootstrap 버전 계산은 다음과 같습니다.

- `release:patch` -> `v0.0.1`
- `release:minor` -> `v0.1.0`
- `release:major` -> `v1.0.0`

프론트엔드는 백엔드 bootstrap 사실을 `metadata.bootstrap_mode: true`로 기록합니다.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Bootstrap 승인 토큰 표기를 다른 규칙 문서와 통일해 주세요.

이 문서는 bootstrap:approved를 사용하지만, 공유 SSOT 문서에서는 bootstrap: approved를 요구하고 있습니다. 운영자가 어느 형식을 써야 하는지 혼선이 생기면 PR 본문 파싱 실패로 배포가 막힐 수 있어, 한 가지 표기로 고정해야 합니다.

🤖 Prompt for 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.

In `@docs/ops/release-record-shared-contract.md` around lines 290 - 298, 문서에서 사용
중인 승인 토큰 표기 'bootstrap:approved'가 다른 SSOT 문서의 'bootstrap: approved'와 불일치하므로 하나로
통일해야 합니다; 문서 내 모든 언급(예: 문장 "백엔드는 ... `bootstrap:approved` 승인을 받은 경우"와 프론트엔드 기록
예시 `metadata.bootstrap_mode: true`)을 찾아 SSOT에서 정한 표기('bootstrap: approved' 또는
SSOT에 명시된 정확한 공백 형식)로 일괄 교정하고, 문서 머리나 변경 이력에 어떤 표기를 표준으로 사용하는지 한 줄로 명시해 주세요.

Comment on lines +61 to +65
`release_id`는 운영 배포 1건을 식별하는 고유 ID입니다. 사람이 언제 배포됐는지 바로 알 수 있도록 배포 시각을 포함합니다.

```txt
prod-YYYYMMDD-HHmm
```

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

release_id 고유성 정의와 포맷 분해능이 충돌합니다.

Line 61에서 고유 ID라고 정의했는데, Line 64 포맷(prod-YYYYMMDD-HHmm)은 같은 분에 2회 배포 시 충돌할 수 있습니다. 초 단위(HHmmss) 또는 suffix(예: run number)를 포함하도록 규칙을 보강해 주세요.

제안 수정안
-`release_id`는 운영 배포 1건을 식별하는 고유 ID입니다. 사람이 언제 배포됐는지 바로 알 수 있도록 배포 시각을 포함합니다.
+`release_id`는 운영 배포 1건을 식별하는 고유 ID입니다. 사람이 언제 배포됐는지 바로 알 수 있도록 배포 시각을 포함하고, 동일 시각 충돌을 피할 수 있어야 합니다.

 ```txt
-prod-YYYYMMDD-HHmm
+prod-YYYYMMDD-HHmmss
</details>

<details>
<summary>🤖 Prompt for AI Agents</summary>

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @docs/ops/version-management.md around lines 61 - 65, The release_id is
defined as a unique identifier but the current format prod-YYYYMMDD-HHmm can
collide for multiple releases inside the same minute; update the release_id
rule to include higher resolution (e.g., change prod-YYYYMMDD-HHmm to
prod-YYYYMMDD-HHmmss) or append a deterministic suffix/run number to guarantee
uniqueness; update the docs text and examples to show the new format and mention
that release_id must be unique per deployment.


</details>

<!-- fingerprinting:phantom:triton:hawk -->

<!-- This is an auto-generated comment by CodeRabbit -->

@Hyeonjun0527 Hyeonjun0527 merged commit cfd66d6 into develop May 18, 2026
17 of 18 checks passed
@Hyeonjun0527 Hyeonjun0527 deleted the chore/docs-ops-move-develop branch May 18, 2026 11:02
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