Skip to content

ci(release): trigger docs build after stable publish#18

Merged
Palbahngmiyine merged 1 commit intomasterfrom
ci/trigger-docs-after-publish
Apr 20, 2026
Merged

ci(release): trigger docs build after stable publish#18
Palbahngmiyine merged 1 commit intomasterfrom
ci/trigger-docs-after-publish

Conversation

@Palbahngmiyine
Copy link
Copy Markdown
Owner

Summary

  • release-please가 기본 GITHUB_TOKEN으로 생성한 GitHub Release의 release: [published] 이벤트가 다음 워크플로를 트리거하지 않는 GitHub Actions 정책이 원인이 되어, solapi-v6.0.0 이후 build-docs.yaml이 자동으로 돌지 않았다.
  • workflow_dispatchGITHUB_TOKEN으로도 정상 기동 가능하므로, release.ymltrigger-docs 잡을 추가해 publish 성공 후 gh workflow run build-docs.yaml --ref \$TAG로 명시적 디스패치한다.

Changes

  • .github/workflows/release.yml: trigger-docs 잡 추가
    • needs: [release-please, publish]
    • gating: needs.release-please.outputs.release_created == 'true' + needs.publish.result == 'success' + github.ref_name == 'master'
    • permissions: actions: write (최소 권한)
    • 릴리즈 태그 기준 커밋에서 빌드되도록 --ref \$TAG 사용

Rationale

옵션 결정
workflow_run 트리거로 교체 Release 워크플로가 release PR 업데이트 등으로도 돌기 때문에 추가 gating이 복잡해짐. 기각
build-docs.yaml 병합 concurrency: pages 그룹과 actions/deploy-pages 제약 유지가 불편. 수동 재빌드도 손실. 기각
gh workflow run 디스패치 (채택) 최소 침습. beta 제외, publish 실패 시 미디스패치, 태그 기준 체크아웃 보장

Test plan

  • YAML 파싱 확인 (python3 yaml.safe_load)
  • 이 PR 자체는 CI(lint/test/build)만 검증 — 실제 trigger 경로는 다음 정식 릴리즈에서 확인 필요
  • 본 PR 머지 전까지, v6.0.0 문서는 fix/typedoc-build-errors PR 머지 후 gh workflow run build-docs.yaml --ref solapi-v6.0.0으로 수동 반영 예정

Related

🤖 Generated with Claude Code

release-please가 기본 GITHUB_TOKEN으로 GitHub Release를 생성할 때,
GitHub Actions 정책상 `release: [published]` 이벤트가 다음 워크플로를
트리거하지 않는다. 이 제약으로 v6.0.0 이후 `build-docs.yaml`이 자동으로
돌지 않아 API Reference가 구버전으로 남아 있었다.

`workflow_dispatch`는 GITHUB_TOKEN으로도 기동이 허용되므로, publish 잡
성공 후 `gh workflow run build-docs.yaml --ref $TAG`로 명시적 디스패치
하는 `trigger-docs` 잡을 추가한다. master 브랜치이고 release_created가
true일 때만 동작하므로 beta 경로나 release PR 생성 단계에서는 트리거
되지 않는다. `--ref $TAG`로 릴리즈 태그 기준 커밋에서 문서를 빌드해
릴리즈와 동일한 소스 상태가 보장된다.

build-docs.yaml 자체는 그대로 유지 — 수동 재빌드 경로와 향후 PAT 전환
시의 release 이벤트 경로 모두 보존.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@Palbahngmiyine Palbahngmiyine merged commit 5c13296 into master Apr 20, 2026
@Palbahngmiyine Palbahngmiyine deleted the ci/trigger-docs-after-publish branch April 20, 2026 07:15
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