Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(ja): api - deployment
Browse files Browse the repository at this point in the history
KentarouTakeda committed Mar 24, 2024
1 parent 199410a commit 6e6b349
Showing 3 changed files with 79 additions and 79 deletions.
30 changes: 15 additions & 15 deletions source/ja/docs/github-pages.md
Original file line number Diff line number Diff line change
@@ -2,20 +2,20 @@
title: GitHub Pages
---

このチュートリアルでは、[GitHub Actions](https://docs.github.com/en/actions) を使用して GitHub Pages をデプロイします。これは公開リポジトリとプライベートリポジトリの両方で機能します。ソースフォルダを GitHub にアップロードしたくない場合は、[ワンコマンドデプロイ](#One-command-deployment) セクションに進んでください。
このチュートリアルでは、[GitHub Actions](https://docs.github.com/en/actions) を使用して GitHub Pages をデプロイします。これはパブリックリポジトリとプライベートリポジトリの両方で機能します。ソースフォルダを GitHub にアップロードしたくない場合は、[ワンコマンドデプロイ](#ワンコマンド・デプロイ) セクションに進んでください。

1. *username*.github.io という名前のリポジトリを作成します。ここで username は GitHub 上のユーザーネームです。他のリポジトリにアップロードしている場合は、リポジトリの名前を変更してください。
2. Hexo フォルダのファイルをリポジトリのデフォルトブランチにプッシュします。デフォルトブランチは通常 **main** ですが、古いリポジトリでは **master** ブランチを使用することがあります
1. <b>*username*.github.io</b> という名前のリポジトリを作成します。username は GitHub 上のユーザー名です。他のリポジトリにアップロードしている場合は、リポジトリの名前を変更してください。
2. Hexo フォルダのファイルをリポジトリのデフォルトブランチにプッシュします。デフォルトブランチは通常 **main** ですが、古いリポジトリでは **master** ブランチかもしれません
- GitHub に `main` ブランチをプッシュするには:

```
$ git push -u origin main
```
- `public/` フォルダはデフォルトでアップロードされません(されるべきではありません)。`.gitignore` ファイルに `public/` 行が含まれていることを確認してください。フォルダ構造は [このリポジトリ](https://github.com/hexojs/hexo-starter) に似ているべきです
- `public/` フォルダはデフォルトでアップロードされません(されるべきではありません)。`.gitignore` ファイルに `public/` 行が含まれていることを確認してください。フォルダ構造は [このリポジトリ](https://github.com/hexojs/hexo-starter) 倣うべきです
3. ローカルマシンで使用している Node.js のバージョンを `node --version` で確認します。メジャーバージョン(例: `v16.y.z`)をメモします
4. GitHub リポの設定で、**Settings** > **Pages** > **Source** に移動します。ソースを **GitHub Actions** に変更して保存します
5. リポジトリに以下の内容で `.github/workflows/pages.yml` を作成します(前のステップでメモした Node.js のメジャーバージョンに `16` を置き換えます):
3. ローカルマシンで使用している Node.js のバージョンを `node --version` で確認し、メジャーバージョン(例: `v16.y.z`)を控えます
4. GitHubリポジトリの設定で、**Settings** > **Pages** > **Source** に移動します。ソースを **GitHub Actions** に変更し保存します
5. リポジトリに以下の内容で `.github/workflows/pages.yml` を作成します(前のステップで控えた Node.js のメジャーバージョンに `16` を置き換えます):
```yml
name: Pages
@@ -76,24 +76,24 @@ jobs:

GitHub でプロジェクトページを持ちたい場合は:

1. GitHub 上でリポジトリに移動します。**Settings** タブに移動します**Repository name** を変更して、ブログが *username.github.io/*repository* で利用できるようにします。**repository***blog**hexo* のような任意の名前にできます
2. **_config.yml** を編集し、`url:` の値を *https://*username*.github.io/*repository* に変更します。
3. GitHub リポの設定で**Settings** > **Pages** > **Source** に移動します。ソースを **GitHub Actions** に変更して保存します
1. GitHubリポジトリで**Settings** タブを表示します**Repository name** を変更して、ブログが <b>username.github.io/*repository*</b> で利用できるようにします。**repository***blog**hexo* など任意の名前にできます
2. **_config.yml** を編集し、`url:` の値を <b>https://*username*.github.io/*repository*</b> に変更します。
3. GitHub リポジトリの設定で**Settings** > **Pages** > **Source** に移動します。ソースを **GitHub Actions** に変更し保存します
4. デフォルトブランチにコミットしてプッシュします。
5. デプロイが完了したら、*username*.github.io/*repository* でウェブページを確認します。

## ワンコマンド・デプロイ

以下の指示は [ワンコマンド・デプロイ](/docs/one-command-deployment) ページからの適応です
以下の説明は [ワンコマンド・デプロイ](../docs/one-command-deployment) からの抜粋です

1. [hexo-deployer-git](https://github.com/hexojs/hexo-deployer-git) をインストールします。
2. **_config.yml** に以下の設定を追加します(存在する場合は既存の行を削除します)。
2. **_config.yml** に以下の設定を追加します(存在する場合は既存の行を修正します)。

```yml
``` yml
deploy:
type: git
repo: https://github.com/<username>/<project>
# 例、https://github.com/hexojs/hexojs.github.io
# example, https://github.com/hexojs/hexojs.github.io
branch: gh-pages
```
@@ -103,5 +103,5 @@ GitHub でプロジェクトページを持ちたい場合は:
## 便利なリンク

- [GitHub Pages](https://docs.github.com/en/pages)
- [カスタムGitHub Actionsワークフローで公開する](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-with-a-custom-github-actions-workflow)
- [Publishing with a custom GitHub Actions workflow](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-with-a-custom-github-actions-workflow)
- [actions/deploy-github-pages-site](https://github.com/marketplace/actions/deploy-github-pages-site)
14 changes: 7 additions & 7 deletions source/ja/docs/gitlab-pages.md
Original file line number Diff line number Diff line change
@@ -2,13 +2,13 @@
title: GitLab Pages
---

1. *username*.gitlab.io という名前の新しいリポジトリを作成します。ここでusernameはGitLab上のユーザーネームです。他のリポジトリにアップロードしている場合は、リポジトリの名前を変更してください。
1. <b>*username*.gitlab.io</b> という名前の新しいリポジトリを作成します。usernameはGitLab上のユーザー名です。他のリポジトリにアップロードしている場合は、リポジトリの名前を変更してください。
2. **Settings** > **CI/CD** > **Runners** > **Enable shared runners for this project** からShared Runnersを有効にします。
3. Hexoフォルダのファイルをリポジトリにプッシュします。`public/` フォルダはデフォルトでアップロードされません(されるべきではありません)、`.gitignore` ファイルに `public/` 行が含まれていることを確認してください。フォルダ構造は [このリポジトリ](https://gitlab.com/pages/hexo) に似ているべきです
4. ローカルマシンで使用しているNode.jsのバージョンを `node --version` で確認します。メジャーバージョン(例`v16.y.z`をメモします
5. `.gitlab-ci.yml` ファイルをリポジトリのルートフォルダ(_config.yml & package.jsonの横)に追加します。以下の内容を含めます(前のステップでメモしたNode.jsのメジャーバージョンに `16` を置き換えます):
3. Hexoフォルダのファイルをリポジトリにプッシュします。`public/` フォルダはデフォルトでアップロードされません(されるべきではありません)、`.gitignore` ファイルに `public/` 行が含まれていることを確認してください。フォルダ構造は [このリポジトリ](https://github.com/hexojs/hexo-starter) 倣うべきです
4. ローカルマシンで使用している Node.js のバージョンを `node --version` で確認し、メジャーバージョン(例: `v16.y.z`を控えます
5. リポジトリに以下の内容で `.github/workflows/pages.yml` を作成します(前のステップで控えた Node.js のメジャーバージョンに `16` を置き換えます):

```yml
``` yml
image: node:16-alpine
cache:
paths:
@@ -29,13 +29,13 @@ pages:
```
6. GitLab CIがデプロイジョブを終了すると、*username*.gitlab.io が動作しているはずです。
7. (オプション)生成されたサイトアセット(html、css、jsなど)を調査したい場合、それらは [ジョブアーティファクト](https://docs.gitlab.com/ee/ci/pipelines/job_artifacts.html) で見つけることができます
7. (任意)生成されたサイトアセット(html、css、jsなど) [ジョブアーティファクト](https://docs.gitlab.com/ee/ci/pipelines/job_artifacts.html) でから見つけることができます
## プロジェクトページ
GitLab上でプロジェクトページを持ちたい場合は:
1. **Settings** > **General** > **Advanced** > **Change path** へ行き、値を変更してウェブサイトが *username.gitlab.io/*repository* で利用できるようにします。*blog* や *hexo* のように任意の名前にできます。
1. **Settings** > **General** > **Advanced** > **Change path** の設定を変更し、ウェブサイトが <b>username.gitlab.io/*repository*</b> で利用できるようにします。*blog* や *hexo* のように任意の名前にできます。
2. **_config.yml** を編集し、`url:` の値を `https://username.gitlab.io/repository` に変更します。
3. コミットしてプッシュします。

114 changes: 57 additions & 57 deletions source/ja/docs/one-command-deployment.md
Original file line number Diff line number Diff line change
@@ -8,16 +8,16 @@ Hexoは迅速かつ簡単なデプロイ戦略を提供します。サイトを
$ hexo deploy
```

サーバー/リポジトリによって提供されるデプロイ方法と互換性のある必要なプラグインをインストールします
デプロイを行うサーバやリポジトリに対応するプラグインをインストールします

デプロイは通常、**\_config.yml**を通じて設定されます。有効な設定には`type`フィールドが必要です。例えば:
デプロイは通常、**\_config.yml**に設定します。設定には`type`フィールドが必要です。例えば:

```yaml
deploy:
type: git
```
複数のデプロイヤーを使用することができます。Hexoは順番に各デプロイヤーを実行します
複数のデプロイを設定することにできます。Hexoは順番に各デプロイを実行します
```yaml
deploy:
@@ -50,16 +50,16 @@ deploy:
オプション | 説明 | デフォルト
--- | --- | ---
`repo` | ターゲットリポジトリのURL |
`branch` | ブランチ名 | `gh-pages` (GitHub)<br>`coding-pages` (Coding.net)<br>`master` (その他)
`message` | コミットメッセージのカスタマイズ。 | `Site updated: {% raw %}{{ now('YYYY-MM-DD HH:mm:ss') }}{% endraw %}`
`token` | リポジトリとの認証に使用するオプションのトークン値。環境変数からトークンを読み込むには`$`をプレフィックスとして使用します
`branch` | ブランチ名 | `gh-pages` (GitHub)<br>`coding-pages` (Coding.net)<br>`master` (その他)
`message` | コミットメッセージをカスタマイズ | `Site updated: {% raw %}{{ now('YYYY-MM-DD HH:mm:ss') }}{% endraw %}`
`token` | リポジトリの認証に使うオプションのトークン値。環境変数からトークンを読み込むには`$`をプレフィックスとして使用

3. サイトをデプロイします `hexo clean && hexo deploy`。

- ターゲットリポジトリのユーザーネームとパスワードが求められますが、トークンまたはsshキーで認証している場合は必要ありません。
- hexo-deployer-gitはユーザーネームとパスワードを保存しません。[git-credential-cache](https://git-scm.com/docs/git-credential-cache)を使用して一時的に保存してください
- ターゲットリポジトリのユーザー名とパスワードが求められますが、トークンまたはsshキーで認証している場合は必要ありません。
- hexo-deployer-gitはユーザー名とパスワードを保存しません。これらを一時的に保存するには [git-credential-cache](https://git-scm.com/docs/git-credential-cache)を使います

4. リポジトリの設定に移動し、"Pages"ブランチを`gh-pages`(または設定で指定されたブランチ)に変更します。"Pages"設定に表示されるリンクでデプロイされたサイトがライブになります
4. リポジトリの設定に移動し、"Pages"ブランチを`gh-pages`(または任意に設定されたブランチ)に変更します。"Pages"設定に表示されるリンクでデプロイされたサイトを表示できます

## Heroku

@@ -81,17 +81,17 @@ deploy:
| オプション | 説明 |
| -------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `repo`, `repository` | HerokuリポジトリURL |
| `message` | コミットメッセージのカスタマイズ (デフォルト: `Site updated: {% raw %}{{ now('YYYY-MM-DD HH:mm:ss') }}{% endraw %}`) |
| `message` | コミットメッセージをカスタマイズ (デフォルト: `Site updated: {% raw %}{{ now('YYYY-MM-DD HH:mm:ss') }}{% endraw %}`) |

## Netlify

[Netlify](https://www.netlify.com/)は、Gitトリガーのビルド、インテリジェントなグローバルCDN、完全なDNS(カスタムドメインを含む)、自動化されたHTTPS、アセットの高速化、さらに多くを提供する統合プラットフォームです。コードを自動化して、高性能でメンテナンスが容易なサイトやWebアプリを作成できます
[Netlify](https://www.netlify.com/)は、Gitトリガーのビルド、インテリジェントなグローバルCDN、完全なDNS(カスタムドメインを含む)、自動化されたHTTPS、アセットの高速化、さらに多くを提供する統合プラットフォームです。高性能でメンテナンスが容易なサイトやWebアプリケーションの作成を自動化します

Netlifyでサイトをデプロイする方法には2つあります。最も一般的な方法は、Web UIを使用することです。[新しいサイトページを作成](https://app.netlify.com/start)に移動し、GitHub、GitLab、Bitbucketからプロジェクトリポジトリを選択し、プロンプトに従ってください。
Netlifyでサイトをデプロイする方法は2つあります。最も一般的な方法は、Web UIを使用することです。[新しいサイトを作成](https://app.netlify.com/start)に移動し、GitHub、GitLab、Bitbucketからプロジェクトリポジトリを選択し、プロンプトに従ってください。

代わりに、Netlifyの[NodeベースのCLI](https://www.netlify.com/docs/cli/)ツールを使用して、ターミナルを離れることなくNetlifyでサイトを管理およびデプロイすることができます
または、Netlifyの[NodeベースのCLI](https://www.netlify.com/docs/cli/)ツールより、ターミナルのみでNetlifyでサイトを管理およびデプロイすることができます

また、READMEファイルに[Netlifyにデプロイするボタン](https://www.netlify.com/docs/deploy-button/)を追加して、他の人があなたのリポジトリのコピーを作成し、ワンクリックでNetlifyにデプロイされるようにすることもできます。
READMEファイルに[Deploy to Netlify Button](https://www.netlify.com/docs/deploy-button/)を追加し、他の人があなたのリポジトリのコピーを作成した後、ワンクリックでNetlifyにデプロイされるようにすることもできます。

## Rsync

@@ -115,15 +115,15 @@ deploy:
ignore_errors: [true|false]
```

| オプション | 説明 | デフォルト |
| --------------- | ------------------------------- | ------- |
| `host` | リモートホストのアドレス |
| `user` | ユーザーネーム |
| オプション | 説明 | デフォルト |
| --------------- | ------------------------------------ | ---------- |
| `host` | リモートホストのアドレス |
| `user` | ユーザー名 |
| `root` | リモートホストのルートディレクトリ |
| `port` | ポート | 22 |
| `delete` | リモートホスト上の古いファイルを削除 | true |
| `verbose` | 冗長メッセージの表示 | true |
| `ignore_errors` | エラーを無視 | false |
| `port` | ポート | 22 |
| `delete` | リモートホスト上の古いファイルを削除 | true |
| `verbose` | 詳細なメッセージを表示 | true |
| `ignore_errors` | エラーを無視 | false |

## OpenShift

@@ -146,10 +146,10 @@ deploy:
message: [message]
```

| オプション | 説明 |
| --------- | ----------------------------------------------------------------------------------------------------------- |
| `repo` | OpenShiftリポジトリURL |
| `message` | コミットメッセージのカスタマイズ (デフォルト: `Site updated: {% raw %}{{ now('YYYY-MM-DD HH:mm:ss') }}{% endraw %}`) |
| オプション | 説明 |
| ---------- | -------------------------------------------------------------------------------------------------------------------- |
| `repo` | OpenShiftリポジトリURL |
| `message` | コミットメッセージをカスタマイズ (デフォルト: `Site updated: {% raw %}{{ now('YYYY-MM-DD HH:mm:ss') }}{% endraw %}`) |

## FTPSync

@@ -174,20 +174,20 @@ deploy:
verbose: [true|false]
```

| オプション | 説明 | デフォルト |
| ------------- | ----------------------------------------- | ------- |
| `host` | リモートホストのアドレス |
| `user` | ユーザーネーム |
| `pass` | パスワード |
| `remote` | リモートホストのルートディレクトリ | `/` |
| `port` | ポート | 21 |
| オプション | 説明 | デフォルト |
| ------------- | -------------------------------------| ---------- |
| `host` | リモートホストのアドレス |
| `user` | ユーザー名 |
| `pass` | パスワード |
| `remote` | リモートホストのルートディレクトリ | `/` |
| `port` | ポート | 21 |
| `ignore` | ホストまたはリモートのファイルを無視 |
| `connections` | 接続数 | 1 |
| `verbose` | 冗長メッセージの表示 | false |
| `connections` | 接続数 | 1 |
| `verbose` | 詳細なメッセージを表示 | false |

## SFTP

[hexo-deployer-sftp]をインストールします。sshエージェントを使用してパスワードなしでSFTP経由でサイトをデプロイできます
[hexo-deployer-sftp]をインストールします。sshエージェントを利用しパスワードなしでSFTP経由でサイトをデプロイできます

```bash
$ npm install hexo-deployer-sftp --save
@@ -208,22 +208,22 @@ deploy:
agent: [path/to/agent/socket]
```

| オプション | 説明 | デフォルト |
| ------------- | ----------------------------------------------- | ---------------- |
| `host` | リモートホストのアドレス |
| `port` | ポート | 22 |
| `user` | ユーザーネーム |
| `pass` | パスワード |
| `privateKey` | sshプライベートキーのパス |
| `passphrase` | プライベートキーのオプションのパスフレーズ |
| `agent` | sshエージェントのソケットのパス | `$SSH_AUTH_SOCK` |
| `remotePath` | リモートホストのルートディレクトリ | `/` |
| `forceUpload` | 既存のファイルを上書き | false |
| `concurrency` | SFTPタスクを並行して処理する最大数 | 100 |
| オプション | 説明 | デフォルト |
| ------------- | ------------------------------------------ | ---------------- |
| `host` | リモートホストのアドレス |
| `port` | ポート | 22 |
| `user` | ユーザー名 |
| `pass` | パスワード |
| `privateKey` | sshプライベートキーのパス |
| `passphrase` | プライベートキーのオプションのパスフレーズ |
| `agent` | sshエージェントのソケットのパス | `$SSH_AUTH_SOCK` |
| `remotePath` | リモートホストのルートディレクトリ | `/` |
| `forceUpload` | 既存のファイルを上書き | false |
| `concurrency` | SFTPタスクを並行して処理する最大数 | 100 |

## Vercel

[Vercel](https://vercel.com)は、開発者がインスタントにデプロイし、自動的にスケールし、監視が不要で、ゼロ設定ですべてを自動化できるクラウドプラットフォームです。グローバルエッジネットワーク、SSL暗号化、アセットの圧縮、キャッシュの無効化などを提供します。
[Vercel](https://vercel.com)は、ゼロコンフィグでJamstackなウェブサイトをインスタントにデプロイし、自動的にスケールする、監視不要なクラウドプラットフォームです。グローバルエッジネットワーク、SSL暗号化、アセットの圧縮、キャッシュの無効化などを提供します。

ステップ1: `package.json`ファイルにビルドスクリプトを追加します:

@@ -239,9 +239,9 @@ deploy:

[Vercel for Git Integration](https://vercel.com/docs/git-integrations)を使用してHexoアプリをデプロイするには、Gitリポジトリにプッシュされていることを確認してください。

[Import Flow](https://vercel.com/import/git)を使用してプロジェクトをVercelにインポートします。インポート中に、すべての関連オプションがあなたに事前設定されて見つかりますが、これらのオプションのいずれかを変更することを選択できます。これらのオプションのリストは[こちら](https://vercel.com/docs/build-step#build-&-development-settings)にあります。
[Import Flow](https://vercel.com/import/git)を使用してプロジェクトをVercelにインポートします。オプションはインポート時に事前設定されますが、何れかを変更することもできます。これらのオプションのリストは[こちら](https://vercel.com/docs/build-step#build-&-development-settings)にあります。

プロジェクトがインポートされた後、ブランチへのすべての後続のプッシュは[Preview Deployments](https://vercel.com/docs/platform/deployments#preview)を生成し、[Production Branch](https://vercel.com/docs/git-integrations#production-branch)(通常は"main")に加えられたすべての変更は[Production Deployment](https://vercel.com/docs/platform/deployments#production)をもたらします
プロジェクトのインポートが完了すると、以降のブランチへのプッシュは[Preview Deployments](https://vercel.com/docs/platform/deployments#preview)を生成し、[Production Branch](https://vercel.com/docs/git-integrations#production-branch)(通常は"main")に加えられたすべての変更は[Production Deployment](https://vercel.com/docs/platform/deployments#production)に反映されます

または、以下のデプロイボタンをクリックして新しいプロジェクトを作成できます:

@@ -251,7 +251,7 @@ deploy:

[Bip](https://bip.sh)は、静的ウェブサイトにゼロダウンタイムデプロイ、グローバルCDN、SSL、無制限の帯域幅などを提供する商用ホスティングサービスです。支払いはドメインごとに従量制で行われます。

BipはHexoをサポートしているため、始めるのは迅速かつ簡単です。このガイドでは、すでに[BipドメインとBip CLIをインストールしている](https://bip.sh/getstarted)ことを前提としています。
BipはHexoをサポートしており、すぐ簡単に初められます。このガイドでは、すでに[Bipドメインを所有しBip CLIをインストールしている](https://bip.sh/getstarted)ことを前提としています。

1: プロジェクトディレクトリを初期化します

@@ -267,7 +267,7 @@ $ bip init
$ hexo generate —deploy && bip deploy
```

数モーメント後、あなたのウェブサイトがデプロイされます
しばらくすると、ウェブサイトがデプロイされます

## RSS3

@@ -282,7 +282,7 @@ $ hexo generate —deploy && bip deploy
2. 設定を変更します。

```yaml
deploy: # すべてのデプロイヤーのためのルート設定ブロック
deploy: # The root configuration block for all deployers
- type: rss3
endpoint: https://hub.rss3.io
privateKey: 47e18d6c386898b424025cd9db446f779ef24ad33a26c499c87bb3d9372540ba
@@ -307,11 +307,11 @@ $ hexo generate —deploy && bip deploy

4. デプロイします

デプロイ関連の考慮事項については、[私たちのドキュメント](https://github.com/NaturalSelectionLabs/hexo-deployer-rss3/blob/develop/README.md)を参照してください。
デプロイ関連の考慮事項については、[ドキュメント](https://github.com/NaturalSelectionLabs/hexo-deployer-rss3/blob/develop/README.md)を参照してください。

## Edgio (旧Layer0)

[Edgio (旧Layer0)](https://docs.edg.io)は、WebアプリとAPIをビルド、リリース、保護、加速するためのインターネットスケールのプラットフォームです
[Edgio (旧Layer0)](https://docs.edg.io)は、WebアプリやAPのをビルド、リリース、保護を加速する、インターネットスケールなプラットフォームです

1. hexoプロジェクトディレクトリで、Edgio CLIをインストールします:

@@ -337,7 +337,7 @@ edgio deploy

## その他の方法

すべての生成されたファイルは、`public`フォルダに保存されます。好きな場所にコピーすることができます
すべての生成されたファイルは、`public`フォルダに保存されます。好きな場所にコピーしてください

[hexo-deployer-git]: https://github.com/hexojs/hexo-deployer-git
[hexo-deployer-heroku]: https://github.com/hexojs/hexo-deployer-heroku

0 comments on commit 6e6b349

Please sign in to comment.