Update README.md

README.md

@@ -18,3 +18,79 @@
 2. 우클릭 해서 New File... 선택해서 파일 템플릿 선택창을 엽니다
 3. Documentation 섹션에서 Documentation Catolog 템플릿을 선택하고 Next 클릭
 4. 파일 이름 필요시 변경
+
+## GitHub Pages 배포하기
+
+### 배포를 위한 깃헙토큰 권한 설정
+```yml
+# GitHub Pages 에 배포하기 위한 GITHUB_TOKEN 권한 설정
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+```
+
+### 필수 설정
+```yml
+environment:
+  # GitHub Pages 로 배포하기 위한 필수 설정
+  name: github-pages
+  url: ${{ steps.deployment.outputs.page_url }}
+```
+
+### 문서 빌드
+
+```yml
+xcodebuild docbuild -scheme {타겟_이름} \
+  -derivedDataPath /tmp/docbuild \
+  -destination 'generic/platform=iOS';
+$(xcrun --find docc) process-archive \
+  transform-for-static-hosting /tmp/docbuild/Build/Products/Debug-iphoneos/{타겟_이름}.doccarchive \
+  --hosting-base-path {레포지토리_이름} \
+  --output-path docs; # docs 라는 경로로 추출
+echo "<script>window.location.href += \"/documentation/{타겟이름_소문자}\"</script>" > docs/index.html
+```
+
+### Artifact 업로드
+
+```yml
+- name: artifact 업로드
+  uses: actions/upload-pages-artifact@v1
+  with:
+    # docs 경로에 있는 것만 업로드
+    path: 'docs'
+```
+
+### GitHub Pages에 배포
+```
+- name: GitHub Pages 에 배포
+  id: deployment
+  uses: actions/deploy-pages@v1
+```
+
+### 마주할 수 있는 문제
+
+#### 스위프트 패키지 빌드 버전 문제
+
+현재 패키지는 5.9 가 최소 빌드 버전이기 때문에 Xcode15 로 버전을 고정시켜주지 않으면 컴파일 에러가 발생
+
+**해결 방법**
+
+macOS 버전 13으로, xcode 버전 15로 설정
+
+```yml
+jobs:
+  deploy:
+  runs-on: macos-13  #최신버전
+  steps:
+  - name: Setup Xcode version
+    uses: maxim-lobanov/setup-xcode@v1 # xcode 버전 설정을 위함
+    with:
+      xcode-version: '15.0'
+```
+
+#### main 을 베이스 브랜치로 하는 PR 에서 배포 안되는 문제
+
+Settings > Environment > GitHub Protection rule 가보면 main 으로 설정되어 있기 때문에 
+해당 규칙이 적용되지 않은 PR 브랜치에서는 배포가 불가능
+