diff --git a/content/posts/2023-07-01/index.md b/content/posts/2023-07-01/index.md new file mode 100644 index 0000000..de41443 --- /dev/null +++ b/content/posts/2023-07-01/index.md @@ -0,0 +1,183 @@ +--- +author: usbharu +draft: true +categories: + - 技術 +date: 2023-07-01T02:47:03+09:00 +tags: + - Gugo + - Golang + - Gitea + - TeamCity + - Cloudflare Pages +keywords: + - Gugo + - Golang +title: Hugo+CF Pages+Gitea+TeamCityでブログを作る +relpermalink: posts/2023-07-01/ +url: posts/2023-07-01/ +decription: HugoとCloudflare PagesとセルフホストGiteaでブログを作る +--- + +## ブログを立てた経緯 + +長文を書く場所が欲しかったところに、ちょうど Hugo というものを知ったため。Qiita とか Zenn と違って心置きなくクソ記事を投稿できる。あと技術以外の旅行とかも書きたいので + +## なぜこの構成なのか + +Cloudflare Pages といえば GitHub や GitLab とのお手軽な連携が有名ですが、画像を大量にアップしたい人としては GitHub は不向きです。 +そもそも画像、ひいてはただの文章を Git 管理しているのが間違いなのですが、なぜか流行っているので仕方ありません。今回も自動でビルドする際の変更を検知する仕組みは Git が使われます。 + +### Hugo + +Golang 製の SSG で、高速らしい。たまたま興味を持ったので採用 + +### Cloudflare Pages + +静的なサイトを設置するのなら Cloudflare Pages や GitHub Pages などの自宅インフラに頼らないサービスを利用するべきという思想。GitHub Pages でもいいけど今回は GitHub を利用しないので Cloudflare Pages を利用。 + +### Gitea + +これまた Golang 製らしい。GitBucket が重たくて困っていた時に使ったら軽量で感動したのでサーバー新調後も使っている。Git サーバーなら何でも可 + +### TeamCity + +JetBrains 社製の CI/CD 環境。JetBrains 社製の製品が好きなので使っている。Jenkins より使いやすい。Gitea Actions でも可 + +## 環境構築 + +今回は Hugo は Winget、テーマは git submodule でインストールします。 + +- Windows 10 +- git インストール済み +- VSCode で執筆 + +### Hugo のインストール + +[Quick Start](https://gohugo.io/getting-started/quick-start/)に従って導入します。後で自動化するので、執筆環境に必ず Hugo が必要というわけではないのですが、初期化には必要なのでとりあえず導入します。Windows ユーザーはコマンドプロンプト、Windows PowerShell は使ってはいけないらしい + +> If you are a Windows user: +> +> Do not use the Command Prompt +> +> Do not use Windows PowerShell +> +> Run these commands from PowerShell or a Linux terminal such as WSL or Git Bash +> PowerShell and Windows PowerShell are different applications. +> +> ― QuickStart | Hugo[^1] + +のですが、普通に動いたのでそのまま使っています。 + +[^1]: https://gohugo.io/getting-started/quick-start/#commands + +#### Winget で Hugo をインストールする + +Windows 標準パッケージマネージャ`winget`を使います。Hugo には拡張版というものがあるらしいのでそっちを使います。 + +```powershell +winget install Hugo.Hugo.Extended +``` + +シェルを再起動しやがれとか言うので面倒だし PC ごと再起動します。 + +#### Hugo を設定する + +```bash +hugo new site {ブログ名} +cd {ブログ名} +git init +git submodule add {利用するテーマのgit repoのurl} themes/{利用するテーマの名前} +#テーマによって設定方法が違うのでテーマに合わせて設定する +``` + +#### テストで記事を書く + +```bash +hugo new posts/test-post/index.md +echo "test" >> posts/test-post/index.md +hugo server +``` + +正常に設定が完了している場合、上記のコマンドをを実行すると URL が出てくるのでそれをクリックします。 +リアルタイムで変更を検知して再ビルドを行ってくれるので一通り機能を試しておきましょう。 + +`Ctrl+C`で終了できます。 + +### CI/CD の整備 + +今回の主題はこっちです。Hugo でブログを立てる記事なんて腐るほどありますからね。 + +Git リポジトリを作成しておいて下さい。 + +#### CI/CD で利用するツールをインストールする + +今回は Cloudflare Pages を利用するので`Wrangler`というツールを使用します。 + +Cloudflare で API Token を発行して下さい。`Edit Cloudlare Workers`や、`Create Custom Token`で`Edit Cloudflare Pages`と`Read Memberships`の権限を与えたら、`Account Resources`を使用するアカウントに変更して下さい。`All accounts`だとひと手間かかります。 + +```cmd +npm init +npm install --save-dev wrangler +set CLOUDFLARE_API_TOKEN={上で作ったToken} +npx wrangler pages project create {ブログ名} +npx wrangler pages publish public #この時点で公開されるので注意 +``` + +#### TeamCity プロジェクトを作製する + +TeamCity は非常に使いやすい UI を持っているので説明しなくてもわかると思うのですが、布教も兼ねて説明します。TeamCity はいいぞ + +##### プロジェクトの作成 + +今回は git サーバーとの連携を使用するため`From a repository URL`を使用し、`Repository URL`に git の URL を入力するだけで完了します。Private repository の場合は認証情報も入力しておきましょう。(1 敗) +![TeamCityのプロジェクト作成画面。URLから作製するか、手動で作製するかを選択できる。](teamcity_create_project.png) + +##### 追跡するブランチの設定 + +今回は git の機能を活用することは無いのでデフォルトのままで使用します。 + +![TeamCityのプロジェクト作成の設定画面。プロジェクト名、追跡するブランチなどを設定している。](teamcity_create_project_2.png) + +##### ビルドステップの設定 + +ビルドステップはビルド時にどのような動作をするかなどの設定です。TeamCity は自動でプロジェクトの内容を解析し、自動でビルドステップを構築してくれる機能がありますが今回は利用しません。`configure build steps manually`をクリックして手動で設定します。 + +![TeamCityで利用できるビルドステップ](teamcity_build_step_list.png) + +###### Hugo ビルドステップの追加 + +TeamCity には Hugo のサポートはありません。今回は Docker の `klakegg/hugo` で動かします。 + +ビルドステップ一覧から Docker を選択し、`Step name`に`Hugo Build`を入力します。 + +`Docker command`は`other…`を選択し、`Command name`に`run`、`Additional arguments for the command`に`--rm -v ./:/src klakegg/hugo:latest`を入力します。 + +![TeamCityでHugoのビルドステップをDockerを利用して設定している。](teamcity_hugo_build_with_docker.png) + +`save`を押して保存し、次のビルドステップを作ります。 + +###### Cloudflare Pages へデプロイするビルドステップの追加 + +TeamCity の`Node.js runner`を利用し、Cloudflare Pages に Push するビルドステップを追加します。 + +```bash +npm ci +npx wrangler pages publish public -project-name {ブログ名} +``` + +![TeamCityのNode.js runnerを利用してCloudflare PagesにPushする構成を追加している](teamcity_configure_cloudflare_pages_push_with_nodejs_runner.png) + +#### Cloudflare Pages の設定 + +カスタムドメイン等を設定しましょう。 + +#### 完成 + +以下のコマンドを打つことで CI/CD が起動し、新規記事が反映されます。非常にめんどくさいのでなんとかしたい。 + +```bash +git add . +git commit -m "new posts" +git push +``` diff --git a/content/posts/2023-07-01/teamcity_build_step_list.png b/content/posts/2023-07-01/teamcity_build_step_list.png new file mode 100644 index 0000000..e06524f Binary files /dev/null and b/content/posts/2023-07-01/teamcity_build_step_list.png differ diff --git a/content/posts/2023-07-01/teamcity_configure_cloudflare_pages_push_with_nodejs_runner.png b/content/posts/2023-07-01/teamcity_configure_cloudflare_pages_push_with_nodejs_runner.png new file mode 100644 index 0000000..6c61bb1 Binary files /dev/null and b/content/posts/2023-07-01/teamcity_configure_cloudflare_pages_push_with_nodejs_runner.png differ diff --git a/content/posts/2023-07-01/teamcity_create_project.png b/content/posts/2023-07-01/teamcity_create_project.png new file mode 100644 index 0000000..bf91551 Binary files /dev/null and b/content/posts/2023-07-01/teamcity_create_project.png differ diff --git a/content/posts/2023-07-01/teamcity_create_project_2.png b/content/posts/2023-07-01/teamcity_create_project_2.png new file mode 100644 index 0000000..2a64083 Binary files /dev/null and b/content/posts/2023-07-01/teamcity_create_project_2.png differ diff --git a/content/posts/2023-07-01/teamcity_hugo_build_with_docker.png b/content/posts/2023-07-01/teamcity_hugo_build_with_docker.png new file mode 100644 index 0000000..a6a69ee Binary files /dev/null and b/content/posts/2023-07-01/teamcity_hugo_build_with_docker.png differ