Skip to content

chore: 릴리즈 시 docs-sync workflow 직접 호출하도록 단순화#496

Merged
Sh031224 merged 2 commits into
mainfrom
chore/auto-deploy-docs-workflow
May 28, 2026
Merged

chore: 릴리즈 시 docs-sync workflow 직접 호출하도록 단순화#496
Sh031224 merged 2 commits into
mainfrom
chore/auto-deploy-docs-workflow

Conversation

@Sh031224
Copy link
Copy Markdown
Contributor

개요

  • 이슈 링크 :

수정사항

  • 릴리즈 발행 시 docs-deploy.yml을 직접 호출하던 구조를 docs-sync.yml 호출로 변경
  • sync/deploy 두 잡을 단일 sync-and-deploy 잡으로 통합
  • docs-sync.ymlplatform=mobile, deploy=true 입력을 전달하여 sync 이후 배포까지 한 번에 트리거

미리보기

워크플로 변경 — 미리보기 해당 없음

@Sh031224 Sh031224 self-assigned this May 28, 2026
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 28, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 7beda5a1-4676-482d-9ea1-00888e9c597a

📥 Commits

Reviewing files that changed from the base of the PR and between 691e107 and 99728d1.

📒 Files selected for processing (1)
  • .github/workflows/auto-deploy-docs.yml

Summary by CodeRabbit

  • Chores
    • 문서 배포 자동화가 단일 동기화·배포 작업으로 통합되어 흐름이 간소화되었습니다.
    • 수동 실행(워크플로우 디스패치) 옵션이 추가되어 필요 시 즉시 동기화/배포를 트리거할 수 있습니다.
    • 기본 배포 대상과 실행 파라미터가 모바일 플랫폼 중심으로 조정되었습니다.

Walkthrough

릴리스 게시 트리거 워크플로우에 workflow_dispatch를 추가하고, jobs.sync/jobs.deploy 분리 구성을 jobs.sync-and-deploy 단일 작업으로 합쳐 내부 호출을 docs-deploy.yml에서 wanteddev/montage-webdocs-sync.yml (ref: main, platform=mobile, deploy=true)으로 변경합니다.

변경사항

문서 배포 워크플로우 통합

Layer / File(s) Summary
작업 통합 및 문서 동기화 호출
.github/workflows/auto-deploy-docs.yml
onworkflow_dispatch 추가, jobssync-and-deploy 단일 작업으로 통합. 내부 gh workflow run 호출을 기존 docs-deploy.yml(needs.sync.outputs.branch, server_type=www, algolia=true)에서 wanteddev/montage-webdocs-sync.yml(ref=main, platform=mobile, deploy=true) 호출로 교체.

예상 코드 리뷰 노력

🎯 3 (Moderate) | ⏱️ ~20 minutes

관련 PR

  • wanteddev/montage-ios#484: 동일 워크플로우 파일의 리팩토링 및 docs-deploy 호출/입력 변경과 관련된 이전 PR입니다.

제안 라벨

AI Review Completed

제안 리뷰어

  • jhseo
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed PR 제목이 주요 변경사항을 명확하게 요약하고 있습니다. 워크플로우 단순화와 docs-sync 직접 호출로의 전환이 핵심 변경사항이며, 제목이 이를 정확히 반영합니다.
Description check ✅ Passed PR 설명이 변경사항과 관련성 있게 작성되었습니다. 기존 구조에서 새로운 구조로의 변경, sync/deploy 통합, 파라미터 전달 방식 변경을 명확히 설명하고 있습니다.
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/auto-deploy-docs-workflow

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

@Sh031224 Sh031224 marked this pull request as ready for review May 28, 2026 07:55
@Sh031224 Sh031224 requested a review from a team as a code owner May 28, 2026 07:55
@Sh031224 Sh031224 requested review from knine79 and removed request for a team May 28, 2026 07:55
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

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 @.github/workflows/auto-deploy-docs.yml:
- Around line 7-9: The workflow currently lacks an explicit permissions block so
the job sync-and-deploy (jobs.sync-and-deploy) runs with default GITHUB_TOKEN
privileges; add an explicit permissions stanza for the workflow or for that job
to minimize scope (e.g., set permissions: none if you exclusively use a separate
GitHub App token, or declare only required scopes such as contents: read and
pages: write) to ensure the job.run-on remains limited to the minimum privileges
needed.
🪄 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: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 37682c78-f99c-46e3-9969-a83176ea045a

📥 Commits

Reviewing files that changed from the base of the PR and between 7f8925e and 691e107.

📒 Files selected for processing (1)
  • .github/workflows/auto-deploy-docs.yml

Comment thread .github/workflows/auto-deploy-docs.yml
@github-actions github-actions Bot added the in review This issue requires a review. label May 28, 2026
@github-actions github-actions Bot added accepted This issue has been reviewed. and removed in review This issue requires a review. labels May 28, 2026
Comment on lines -8 to -10
sync:
uses: wanteddev/montage-web/.github/workflows/docs-sync.yml@main
secrets: inherit
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

uses: wanteddev/montage-web/.github/workflows/docs-sync.yml@main

-> montage-ios 코드 상태에서 docs-sync 실행합니다.

그러나 docs-sync 내부 코드에서 ./.github/actions/pnpm-install/action.yml을 참조하고 있었는데,
현재 코드 베이스는 montage-ios이기 때문에 pnpm-install/action.yml를 찾지 못하여 오류가 발생했습니다.

기존에는 sync -> 변경사항이 있다면 문서 배포 까지 이 workflow(auto-deploy-docs) 에서 진행했는데,
montage-web의 docs-sync.yml 에서 진행하도록 위임하고, 여기 저장소에서는 단순 github cli를 통해 dispatch만 하도록 변경했습니다

@knine79 knine79 added this to the 3.9.1 milestone May 28, 2026
@github-actions github-actions Bot added in review This issue requires a review. and removed accepted This issue has been reviewed. labels May 28, 2026
@knine79 knine79 modified the milestones: 3.9.1, 3.9.2 May 28, 2026
@Sh031224 Sh031224 merged commit 9f58a4c into main May 28, 2026
2 checks passed
@Sh031224 Sh031224 deleted the chore/auto-deploy-docs-workflow branch May 28, 2026 08:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

in review This issue requires a review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants