Skip to content

Commit 99b751a

Browse files
kimhkimh
authored
Translation update (circleci#3153)
1 parent 34399e6 commit 99b751a

File tree

1 file changed

+49
-36
lines changed

1 file changed

+49
-36
lines changed

‎jekyll/_cci2_ja/getting-started.md

Lines changed: 49 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -3,31 +3,31 @@ layout: classic-docs
33
title: "はじめに"
44
short-title: "はじめに"
55
description: "CircleCI で成功 (グリーン) ビルドを行うためのチュートリアル"
6-
categories:
7-
- getting-started
6+
categories: [getting-started]
87
order: 41
98
---
9+
1010
このドキュメントでは、CircleCI 2.0 で成功 (グリーン) ビルドを行うための詳しい手順を説明します。
1111

1212
* 目次
1313
{:toc}
1414

1515
## ビルドにあたっての前提条件
16+
{:.no_toc}
1617

17-
* Git に関する基礎的な知識があり、GitHub のアカウントを所有している、もしくはアカウントを作成する権限があること。ここでは GitHub の新しいリポジトリを使用した手順を説明しますが、実際には Bitbucket も利用できます。
18+
* Git および既存の GitHub.com アカウント、またはアカウントの作成についての基本的な知識。 この手順では新しい GitHub リポジトリを使用しますが、CircleCI では Bitbucket の使用もサポートしています。
1819
* ターミナルや `bash` についての基本的な知識。またコマンドラインの使用経験があれば役に立ちます。
1920

2021
## リポジトリの作成
21-
2222
1. GitHub.com で自分のアカウントに移動します。
23-
24-
* **[Repositories]** タブに移動し、 **[New]** を選択するか、<https://github.com/new> に直接移動します。 ![]({{ site.baseurl }}/assets/img/docs/GH_Repo-New-Banner.png)
23+
* **[Repositories]** タブに移動し **[New]** を選択するか、<https://github.com/new> に直接移動します。 ![]({{ site.baseurl }}/assets/img/docs/GH_Repo-New-Banner.png)
2524

2625
2. [Initialize this repository with a README] にチェックを入れて、[Create repository] ボタンをクリックします。![]({{ site.baseurl }}/assets/img/docs/create-repo-circle-101-initialise-readme.png)
2726

2827
## .yml ファイルの追加
2928

30-
CircleCI は、テスト環境の構築方法や実行するテスト内容の定義に [YAML](https://en.wikipedia.org/wiki/YAML) ファイルを使います。 CircleCI 2.0 では、`config.yml` というファイル名で、隠しフォルダである `.circleci` ディレクトリ配下に作成しておく必要があります。 macOS、Linux、Windows においては、ピリオドから始まるファイルやフォルダは、デフォルトで隠し属性のある*システム*ファイルとして扱われますので、ご注意ください。
29+
CircleCI は、テスト環境の構築方法や実行するテスト内容の定義に [YAML](https://en.wikipedia.org/wiki/YAML) ファイルを使います。
30+
CircleCI 2.0 では、`config.yml` というファイル名で、隠しフォルダである `.circleci` ディレクトリ配下に作成しておく必要があります。macOS、Linux、Windows においては、ピリオドから始まるファイルやフォルダは、デフォルトで隠し属性のある*システム*ファイルとして扱われますので、ご注意ください。
3131

3232
1. GitHub でファイルやフォルダを作成するには、リポジトリページの **[Create new file]** ボタンをクリックし、`.circleci/config.yml` と入力します。 空の `config.yml` ファイルが `.circleci` フォルダ内に作成されます。
3333

@@ -44,13 +44,13 @@ jobs:
4444
- run: echo "A first hello"
4545
```
4646
47-
1. コメントを入力してから、[Commit New File] ボタンをクリックしてファイルをコミットします。![]({{ site.baseurl }}/assets/img/docs/commit-new-file.png)
47+
3. コメントを入力してから、[Commit New File] ボタンをクリックしてファイルをコミットします。![]({{ site.baseurl }}/assets/img/docs/commit-new-file.png)
4848
4949
`- image: circleci/ruby:2.4.1` という部分は、プロジェクトをビルドする際にどの Docker イメージを使うか指定しているものです。 CircleCI は、イメージを使用して「コンテナ」を立ち上げます。コンテナとは、プロジェクトの実行に必要な言語、システムユーティリティ、依存関係、Web ブラウザー、ツールなどがインストールされる仮想コンピューティング環境です。
5050

5151
## CircleCI 上でのビルドの準備
5252

53-
1. この手順を実行するには、CircleCI アカウントが必要です。 CircleCI の[ユーザー登録ページ](https://circleci.com/signup)を開き、[GitHub でログイン] をクリックします。 ビルドを実行するには、GitHub アカウントに CircleCI へのアクセスを許可する必要があります。 CircleCI アカウントを既に持っている場合は、[ダッシュボード](https://circleci.com/dashboard)にアクセスします。
53+
1. この手順を実行するには、CircleCI アカウントが必要です。 CircleCI の[ユーザー登録ページ](https://circleci.jp/signup)を開き、[GitHub でログイン] をクリックします。 ビルドを実行するには、GitHub アカウントに CircleCI へのアクセスを許可する必要があります。 CircleCI アカウントを既に持っている場合は、[ダッシュボード](https://circleci.com/dashboard)にアクセスします。
5454

5555
2. 次に、CricleCI で既に構築され、自分がアクセス可能なプロジェクトを*フォローする*かどうかのオプションが表示されます (これは通常、会社や組織の GitHub アカウントを使用している開発者に表示されます)。 次の画面では、作成したリポジトリを、新しいプロジェクトとして CircleCI に追加できます。
5656

@@ -60,21 +60,24 @@ jobs:
6060

6161
## CircleCI での初めてのビルド
6262

63-
ビルドが開始され、自動的に正しく実行されるはずです。実行結果を確認します。CircleCI ダッシュボードに表示される緑色の [SUCCESS] ボタンをクリックすると、実行の次の部分を調べることができます。
63+
ビルドが開始され、自動的に正しく実行されるはずです。 実行結果を確認します。 CircleCI ダッシュボードに表示される緑色の [SUCCESS] ボタンをクリックすると、実行の次の部分を調べることができます。
6464

65-
1. **環境のスピンアップ：** CircleCI は、`circleci/ruby:2.4.1` Docker イメージを使用して、仮想コンピューティング環境をローンチしました。
65+
1. **環境のスピンアップ :** CircleCI は、`circleci/ruby:2.4.1` Docker イメージを使用して、仮想コンピューティング環境をローンチしました。
6666

67-
2. **チェックアウトコード：** CircleCI は、GitHub リポジトリをチェックアウトし、手順 1 でローンチされた仮想環境に「クローン」しました。
67+
2. **チェックアウトコード :** CircleCI は、GitHub リポジトリをチェックアウトし、手順 1 でローンチされた仮想環境に「クローン」しました。
6868

69-
3. **echo：** これは、`config.yml` に含まれる唯一の他の命令です。CircleCI は 「A first hello」という入力を echo コマンドに渡して実行します。 ([echo](https://linux.die.net/man/1/echo) コマンドは、入力された文字列をそのまま出力します)。
69+
3. **echo :** これは、`config.yml` に含まれる唯一の他の命令です。CircleCI は echo コマンドを実行し、「A first hello」という入力を与えました ([echo](https://linux.die.net/man/1/echo) コマンドは、入力された文字列をそのまま出力します)。
7070

7171
今のところはリポジトリにソースコードが含まれておらず、`config.yml` 内にもテストに関わる設定が含まれていませんが、CircleCI はビルドに「成功」したものとして扱います ([exit コード](https://en.wikipedia.org/wiki/Exit_status)としては 0 を返しているため)。 ほとんどのプロジェクトは、これよりはるかに複雑で、多くの場合は複数の Docker イメージと複数のステップが存在し、多くのテストも含まれます。 `config.yml` ファイルに記述できる全てのステップの詳細については、[CircleCI の設定方法](https://circleci.com/docs/ja/2.0/configuration-reference)を参照してください。
7272

73-
## ビルドを意図的に失敗させる
73+
### ビルドを意図的に失敗させる
74+
{:.no_toc}
7475

7576
単純化のため、GitHub エディターで `config.yml` ファイルを編集し、`echo "A first hello"` を `notacommand` に置き換えます。 GitHub エディターの **[Commit change]** ボタンをクリックします。 CircleCI の {% comment %} TODO: Jobs {% endcomment %}Builds ページに戻ると、新しいビルドがトリガーされています。 このビルドは失敗し、赤色の [FAILED] ボタンが表示され、失敗を通知するためのメールが送信されます。
7677

77-
## Workflows 機能の使用
78+
79+
### Workflows 機能の使用
80+
{:.no_toc}
7881

7982
1. Workflows の動作を見るには、`.circleci/config.yml` ファイルを編集します。 ブラウザーのウィンドウでファイルを編集モードにしてから、ファイル内で `build` とそれ以後のテキストを選択し、コピー＆ペーストし、そのセクションを複製します。 コードブロックは次のようになります。
8083

@@ -92,14 +95,16 @@ jobs:
9295
- image: circleci/ruby:2.4.1
9396
steps:
9497
- checkout
95-
- run: echo "A first hello"
98+
- run: echo "A first hello"
9699
```
97100

98-
1. 次に、2 つのジョブを別々の名前にします。 この例では、`one` と `two` という名前にします。 echo コマンドの部分も別のものに変更します。 {% comment %} TODO: Job {% endcomment %}ビルドの実行に必要な時間をあえて長くするため、システムの `sleep` コマンドを追加します。
101+
1. 次に、2 つのジョブを別々の名前に変更します。 この例では、`one` と `two` という名前にします。 echo コマンドの部分も別のものに変更します。 {% comment %} TODO: Job {% endcomment %}ビルドの実行に必要な時間をあえて長くするため、システムの `sleep` コマンドを追加します。
102+
103+
2. `config.yml` ファイルに `workflows` セクションを追加します。 workflows セクションは、ファイルのどこにでも配置できます。 通常は、ファイルの先頭または末尾に配置します。
99104

100-
2. `config.yml` に `workflows` セクションを追加します。workflows セクションは、ファイルのどこにでも配置できます。通常は、ファイルの先頭または末尾に配置します。
101105

102106
```yml
107+
version: 2
103108
jobs:
104109
one:
105110
docker:
@@ -123,13 +128,14 @@ workflows:
123128
- two
124129
```
125130

126-
1. これらの変更をリポジトリにコミットしてから、CircleCI のダッシュボードに戻ります。![]({{ site.baseurl }}/assets/img/docs/workflows-circle-101-running.png)
131+
4. これらの変更をリポジトリにコミットしてから、CircleCI のダッシュボードに戻ります。![]({{ site.baseurl }}/assets/img/docs/workflows-circle-101-running.png)
127132

128-
2. Workflow のリンクをクリックすると、2 つのジョブが並列実行されていることを確認できます。![]({{ site.baseurl }}/assets/img/docs/inside-workflows-circle-101-running.png)
133+
5. Workflow のリンクをクリックすると、2 つのジョブが並列実行されていることを確認できます。![]({{ site.baseurl }}/assets/img/docs/inside-workflows-circle-101-running.png)
129134

130-
Workflows の詳細については、[「Workflows の制御」](https://circleci.com/docs/ja/2.0/workflows/#overview)ドキュメントを参照してください。
135+
Workflows の詳細については「[Workflows の制御](https://circleci.com/docs/ja/2.0/workflows/#overview)」ドキュメントを参照してください。
131136

132-
## Workspaces 機能を使ってみる
137+
### Workspaces 機能を使ってみる
138+
{:.no_toc}
133139

134140
各 Workflow には Workspace が割り当てられています。Workspace は、Workflow の進行につれてダウンストリームのジョブにファイルを転送するために使用されます。 Workspaces を使用して、その実行に固有のダウンストリームのジョブで必要となるデータを渡すことができます。 `config.yml` を次のように書き換えてみてください。
135141

@@ -149,13 +155,13 @@ jobs:
149155
root: my_workspace
150156
# root からの相対パスにする必要があります
151157
paths:
152-
- echo-output
158+
- echo-output
153159
two:
154160
docker:
155161
- image: circleci/ruby:2.4.1
156162
steps:
157163
- checkout
158-
- run: echo "A more familiar hi"
164+
- run: echo "A more familiar hi"
159165
- attach_workspace:
160166
# 絶対パス、または working_directory からの相対パスにする必要があります
161167
at: my_workspace
@@ -178,48 +184,55 @@ workflows:
178184

179185
Workspaces の詳細については、[こちら](https://circleci.com/docs/ja/2.0/workflows/#using-workspaces-to-share-data-among-jobs)を参照してください。
180186

181-
## SSH での{% comment %} TODO: Job {% endcomment %}ビルドへの接続
187+
### SSH での{% comment %} TODO: Job {% endcomment %}ビルドへの接続
188+
{:.no_toc}
182189

183190
![]({{ site.baseurl }}/assets/img/docs/SSH-screen.png)
184191

185192
ターミナルの操作に慣れている場合、SSH enabled オプションで{% comment %} TODO: Job {% endcomment %}ビルドを再実行することで、CircleCI のジョブに SSH で直接接続してビルドのトラブルシューティングを行えます。
186193

187-
*この場合、GitHub アカウントに SSH キーを追加する必要があることに注意してください。詳細については、<https://help.github.com/articles/connecting-to-github-with-ssh/>* を参照してください。
194+
*この場合、GitHub アカウントに SSH キーを追加する必要があることに注意してください。詳細については下記のリンクを参照してください。
195+
<https://help.github.com/articles/connecting-to-github-with-ssh/>*
188196

189197
![]({{ site.baseurl }}/assets/img/docs/rebuild-with-SSH.png)
190198

191199
![]({{ site.baseurl }}/assets/img/docs/SSH-build-terminal-string.png)
192200

193-
ビルドの SSH の有効化セクションから、`ssh` の接続先をコピーします。ターミナルを開き、`ssh` の接続先を貼り付けます。
201+
ビルドの SSH の有効化セクションから、`ssh` の接続先をコピーします。 ターミナルを開き、`ssh` の接続先を貼り付けます。
194202

195203
以下のコマンドのいくつかを使用すると、Workspaces を使用して作成したファイルの内容を検索し、表示できます。
196204

197-
pwd # print what directory の略で、現在のディレクトリがファイルシステムのどこなのかを確認できます
198-
ls -al # list の略で、現在のディレクトリに存在するファイルとディレクトリを一覧表示します
199-
cd <directory_name> # ディレクトリを <directory_name> ディレクトリに変更します
200-
cat <file_name> # <file_name> で指定したファイルの内容を表示します
201-
205+
```
206+
pwd # print what directory の略で、現在のディレクトリがファイルシステムのどこなのかを確認できます
207+
ls -al # list の略で、現在のディレクトリに存在するファイルとディレクトリを一覧表示します
208+
cd <directory_name> # ディレクトリを <directory_name> ディレクトリに変更します
209+
cat <file_name> # <file_name> で指定したファイルの内容を表示します
210+
```
202211
203212
## 関連情報
213+
{:.no_toc}
204214
205215
Git フックでのコミットごとに CircleCI の `config.yml` をバリデーションする方法については[こちらのブログ](https://circleci.com/blog/circleci-hacks-validate-circleci-config-on-every-commit-with-a-git-hook/)で紹介しています。
206216
207-
### CircleCI
217+
### CircleCI に関する資料
218+
{:.no_toc}
208219
209-
* CircleCI のブログとフォロー方法
220+
* CircleCI のブログとフォロー方法
210221
* <https://circleci.com/blog/>
211-
* 関連するブログ投稿
222+
* 関連するブログ投稿
212223
* <https://circleci.com/blog/what-is-continuous-integration/>
213-
* CircleCI の SNS アカウントと GitHub アカウント
224+
* CircleCI の SNS アカウントと GitHub アカウント
214225
* <https://github.com/circleci>
215226
* <https://twitter.com/circlecijapan>
216227
* <https://www.facebook.com/circleci>
217228
218229
### 継続的インテグレーション
230+
{:.no_toc}
219231
220232
* <https://martinfowler.com/articles/continuousIntegration.html>
221233
* [https://en.wikipedia.org/wiki/Continuous_integration#Best_practices](https://en.wikipedia.org/wiki/Continuous_integration#Best_practices)
222234
223235
### YAML
236+
{:.no_toc}
224237
225238
* <https://en.wikipedia.org/wiki/YAML#Advanced_components>

0 commit comments

Comments
 (0)