プロジェクトとWebSiteを一緒にしたい

備忘録です。
# はじめに

モバイルアプリの開発において、アプリケーションの紹介 Web サイトやプライバシーポリシーを同じリポジトリで管理したいと思いました。今回はその問題を解決する方法を紹介します。

なお、今回は Web サイトのデプロイ先をGitHub Pages に限定しています。

# 方法

## GitHub Pages の設定
任意のリポジトリを作成したら、GitHub Pages へ移動して、"Build and deployment" を "GitHub Actions" に変更します

![スクリーンショット 2024-06-18 15.40.50.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/707293/489eccea-4974-0ad7-3430-56d8007393ea.png)

## ワークフローの作成
設定を変更すると、以下のようなワークフローが作成されます。

:::note warn
以下のコードは突然変更される場合がありますので、GitHubが生成したファイルを使用してください。
:::

```yaml: HTML
# Simple workflow for deploying static content to GitHub Pages
name: Deploy static content to Pages

on:
  # Runs on pushes targeting the default branch
  push:
    branches: ["main"]

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  # Single deploy job since we're just deploying
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Setup Pages
        uses: actions/configure-pages@v5
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          # Upload entire repository
          path: '.'
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4
```
## パスの編集
プロダクトのWebサイトの置き場所を `./website` ディレクトリに指定する場合、以下のように修正すると、GitHub Pagesに反映されます。

```diff_yaml: HTML
# Simple workflow for deploying static content to GitHub Pages
name: Deploy static content to Pages

on:
  # Runs on pushes targeting the default branch
  push:
    branches: ["main"]

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  # Single deploy job since we're just deploying
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Setup Pages
        uses: actions/configure-pages@v5
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          # Upload entire repository
-          path: '.'
+          path: './website'          
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4
```
## おしまい！
あとは `./website` ディレクトリの中に必要なファイルを追加していくだけです。

サンプルコードは HTML のワークフローですが、jekyll でも同様の対応で　WebSiteを作成できます。jekyll の場合は、`./website` ディレクトリに Markdown ファイルを追加してください。

# サンプル
以下はサンプルのリポジトリ

https://github.com/KaitoMuraoka/SampleAppWithWeb

# 参考文献
https://docs.github.com/ja/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site

https://docs.github.com/ja/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll