Skip to content

README 진행 상태 로그 삭제와 구조 최신화 - #34

Merged
m-a-king merged 4 commits into
mainfrom
docs/readme-slim
Aug 10, 2026
Merged

README 진행 상태 로그 삭제와 구조 최신화#34
m-a-king merged 4 commits into
mainfrom
docs/readme-slim

Conversation

@m-a-king

@m-a-king m-a-king commented Aug 9, 2026

Copy link
Copy Markdown
Contributor

Situation

  • README 정리에서 시스템 구성의 정본을 core README 로 정했다 (나머지 repo 는 core 를 참조). 이 README 의 진행 상태 섹션은 약 90줄의 날짜별 작업 로그로 자라 있었고, 두 트랙(배포·개발 규약 공통화)은 이미 종결되어 유지보수 모드다
  • 로컬 체크아웃에는 구조 트리·transport 서술을 최신화한 문서 개선이 커밋되지 않은 채 남아 있었다

Task

  • README 를 이 repo 의 계약(입장 기준·블록 원칙·구조)만 남기고, 커밋되지 않았던 문서 개선을 흡수한다

Action

  • 진행 상태 섹션을 삭제. 작업 기록은 git 이력과 각 PR 이 소유한다
  • 구조 트리에 observability.md·run_container·alloy 블록을 반영하고, SSH runner 단일 확정을 본문에 반영 (transport 어댑터 서술 제거). 로컬에 커밋되지 않은 채 남아 있던 개선을 이 PR 로 흡수했다
  • 전체 시스템 구성은 core README 를 참조하는 한 줄 추가

Result

  • 날짜별 로그가 append 되던 압력이 사라져, README 는 이 repo 의 계약 문서로 고정된다

연관 이슈

Summary by CodeRabbit

  • 문서
    • 공통 배포 자산과 서비스별 배포 구성 방식을 명확히 설명하도록 README를 업데이트했습니다.
    • SSH Runner 기반 실행 방식과 Bash 블록 사용 기준을 반영했습니다.
    • 컨테이너 실행 및 관측 관련 구성 요소를 구조 목록에 추가했습니다.
    • 기존 진행 상태 섹션을 제거했습니다.

- 완료 트랙의 날짜별 작업 로그(진행 상태 섹션)를 삭제. 기록은 git 이력과 PR 이 소유한다
- 구조 트리에 observability.md·run_container·alloy 블록을 반영하고 SSH 단일 transport 확정을 본문에 반영 (로컬 체크아웃에 커밋되지 않은 채 남아 있던 문서 개선을 흡수)
- 전체 시스템 구성은 core README 를 참조하도록 한 줄 추가
@m-a-king m-a-king added the docs 문서만 만지는 작업 label Aug 9, 2026
@m-a-king m-a-king self-assigned this Aug 9, 2026
@coderabbitai

coderabbitai Bot commented Aug 9, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 81f652ea-b069-4bab-b8b3-af2c8a6d8ece

📥 Commits

Reviewing files that changed from the base of the PR and between af8b081 and acd4ac0.

📒 Files selected for processing (1)
  • README.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • README.md

📝 Walkthrough

Walkthrough

README.md가 배포 공통화 구조를 정리했다. 서비스별 deploy.yml 조립 방식과 SSH runner 단일 실행 방식을 명시했다. run_container, 관련 테스트, Alloy 공통 블록을 구조 목록에 추가하고 기존 진행 상태를 삭제했다.

Changes

배포 공통화 문서

Layer / File(s) Summary
배포 계약과 공통 자산 범위
README.md
공유 블록과 배포 계약을 각 서비스의 deploy.yml에서 조립하는 구조를 명시했다. 공통 자산 범위와 시스템 참고 링크를 추가했다.
실행 기반과 저장소 구조
README.md
SSH runner 단일 실행 방식을 명시했다. 관측 계약, run_container, 테스트, Alloy 공통 블록을 구조 목록에 추가했다. 기존 진행 상태 체크리스트를 삭제했다.

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

Possibly related PRs

🚥 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 README의 진행 상태 로그 삭제와 구조 문서 최신화를 명확하게 요약합니다.
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 💡 1
⚔️ Resolve merge conflicts 💡
  • Resolve merge conflict in branch docs/readme-slim

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

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 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 `@README.md`:
- Around line 47-52: Update the README directory description for blocks/ so it
no longer claims the directory contains only pure Bash; describe it as
containing shared execution-neutral blocks, including observability
configuration such as the alloy subdirectory and config.alloy.
- Around line 46-52: install.sh의 정본 자산 목록과 복사 대상 경로에 contracts/observability.md,
blocks/run_container.sh, blocks/run_container.test.sh,
blocks/alloy/config.alloy, blocks/alloy/provision-alloy.sh를 추가하세요. 새 Alloy 블록이
실제 설치되도록 provision-alloy.sh의 호출부와 SSM 주입 기준도 함께 갱신하고, README의 SSET 설명과 일치하는지
확인하세요.
🪄 Autofix

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: 830af8a6-aea5-4cb0-80e2-2e52669f8ec6

📥 Commits

Reviewing files that changed from the base of the PR and between 1858b0c and af8b081.

📒 Files selected for processing (1)
  • README.md

Comment thread README.md
Comment thread README.md Outdated
- blocks/ 를 순수 bash 로 서술했지만 alloy/ 의 config.alloy 는 관측 설정이라 불일치 (CodeRabbit 지적 수용)
- install.sh 가 배포 갈래(blocks·contracts)까지 설치한다는 오독이 나와, 설치 대상이 개발 규약 갈래뿐임을 주석에 명시. 배포 자산은 각 서비스 deploy 가 원격 fetch 로 소비한다
- main 의 #33(infra 자신에도 스킬 설치)이 진행 상태 불릿을 수정해 삭제와 충돌했다. 로그 삭제는 유지하고, 바뀐 사실만 유지되는 구조 트리 주석에 흡수
@m-a-king
m-a-king merged commit f359993 into main Aug 10, 2026
2 checks passed
@m-a-king
m-a-king deleted the docs/readme-slim branch August 10, 2026 15:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs 문서만 만지는 작업

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant