Skip to content

Commit e9271af

Browse files
committed
表現の修正・統一
1 parent 2ab000a commit e9271af

File tree

3 files changed

+19
-19
lines changed

3 files changed

+19
-19
lines changed

docs/text/chapter-2/get-verified.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
## 成り済まし
66

7-
Gitea 上でリポジトリにコミットした人のアイコンなどを表示できればとても便利です。ところが Git(ソフトウェア)と traP Gitea(ホスティングサービス)は別個の存在なので、Git で行うコミットなどの操作に Gitea が介入することはできません。
7+
Gitea 上でリポジトリにコミットした人のアイコンなどを表示できればとても便利です。ところが Git(ソフトウェア)と traP Gitea(ホスティングサービス)は別個の存在なので、Git で行うコミットなどの操作自体に Gitea が介入することはできません。
88

9-
コミットに埋め込まれている個人の情報は基本的にはメールアドレスしかないので、Gitea はこのメールアドレスを紐づけているアカウントを検索して見つかったものを「コミットしたユーザー」として表示します。すなわち、あなたが誰かのメールアドレスを知っていて、それを [必要なツール](/text/chapter-1/requirements) の章で設定すると、あなたはそのユーザーに成り済ますことができます。
9+
コミットに埋め込まれている個人の情報は基本的にはメールアドレスしかないので、Gitea はこのメールアドレスを紐づけているアカウントを検索して見つかったものを「コミットしたユーザー」として表示します。すなわち、あなたが誰かのメールアドレスを自身のアドレスとしてコミットに埋め込むと、あなたはそのユーザーに成り済ますことができます。
1010

1111
![](https://md.trap.jp/uploads/upload_c3c585adcf6538d92a3e16eaf23fdd2b.png)
1212
<p style="font-size: 12px; text-align: center; margin: -16px 0 20px 0">本人に許可を得てメールアドレスを借りています</p>
@@ -24,7 +24,7 @@ Gitea 上でリポジトリにコミットした人のアイコンなどを表
2424

2525
- 公開鍵暗号は **署名** すなわち渡す情報の正統性の証明に用いることもでき、この場合秘密鍵 $f^{-1}$ が暗号化関数としてはたらきます。渡したい情報から固有に得られる値 $b$ を $f^{-1}$ で暗号化した $f^{-1}(b) = b'$ を署名として情報に添えて渡します。公開鍵 $f$ によって確かに $f(b') = b$ が成り立つことを相手に確認してもらい、秘密鍵を所持する本人であると証明することができます。
2626

27-
コミットの署名ではコミットの内容やコミットメッセージなどの情報全体をハッシュ関数にかけた値を $b$ として署名に用います。
27+
以上が公開鍵暗号による情報の保護・署名の仕組みの非厳密な説明です。コミットの署名ではコミットの内容やコミットメッセージなどの情報全体をハッシュ関数にかけた値を $b$ として署名に用います。
2828
:::
2929

3030
[SSH キーの登録](/text/chapter-1/gitea-ssh.html#ssh-%E3%82%AD%E3%83%BC%E3%81%AE%E7%94%9F%E6%88%90) の章で生成した SSH キーは、ホームディレクトリ直下の `.ssh` という隠しディレクトリの中にあります。ターミナルで以下を実行したとき、一覧の中にある `id_ed25519` が秘密鍵、`id_ed25519.pub` が公開鍵です(pub = public)。
@@ -47,7 +47,7 @@ Gitea の [SSH / GPG キー](https://git.trap.jp/user/settings/keys) のペー
4747
echo -n 'トークン' | ssh-keygen -Y sign -n gitea -f ~/.ssh/id_ed25519.pub
4848
```
4949

50-
すると、以下のような形式の SSH 署名が出力されるはずです。これを「Armor 形式の SSH 署名」欄に貼り付けて「確認」ボタンを押します。
50+
すると、以下のような形式の SSH 署名が出力されるはずです。これを「Armor 形式の SSH 署名」欄に貼り付けて、その下の「確認」ボタンを押します。
5151

5252
```
5353
-----BEGIN SSH SIGNATURE-----
@@ -78,9 +78,9 @@ git config --global user.signingkey ~/.ssh/id_ed25519.pub
7878

7979
:::warning ダミーメールアドレスでは署名に失敗します
8080

81-
`git config` で個人用のメールアドレスを設定していれば以上の手順で問題なく署名されますが、[前章](/text/chapter-2/hide-address.html) の手順に従ってダミーアドレスを設定した後では署名に失敗するという現象を観測しました。どうやらこれは traP Gitea [仕様](https://q.trap.jp/messages/019a1164-f66d-7546-9aff-79f33490c833) みたいです。2025 年現在、Gitea で署名に使えるメールアドレスは [traPortal](https://portal.trap.jp/) で個人用に設定しているただ一つの実メールアドレスに限られています。
81+
`git config` で個人用のメールアドレスを設定していれば以上の手順で問題なく署名されますが、[前章](/text/chapter-2/hide-address.html) の手順に従ってダミーアドレスを設定した後では署名に失敗するという現象を観測しました。どうやらこれは traP Gitea の仕様みたいです([参考](https://q.trap.jp/messages/019a1164-f66d-7546-9aff-79f33490c833)。2025 年現在、Gitea で署名に使えるメールアドレスは [traPortal](https://portal.trap.jp/) で個人用に設定しているただ一つの実メールアドレスに限られています。
8282

83-
traP Gitea で「実メールアドレスでコミットに署名する」ことと「メールアドレスを秘匿して署名を諦める」ことのどちらを優先するかは個々人の価値判断にお任せしますが、GitHub ではこれらの設定を両立させることが可能なので、ぜひ両立させましょう。
83+
traP Gitea で「実メールアドレスでコミットに署名する」ことと「メールアドレスを秘匿して署名を諦める」ことのどちらを優先するかは個々人の価値判断にお任せします。ただし、GitHub ではこれらの設定を両立させることが可能なので、ぜひ両立させましょう。
8484

8585
:::
8686

docs/text/chapter-2/hide-address.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ Gitea のダミーアドレスの設定と GitHub のダミーアドレスの設
9393

9494
![](https://md.trap.jp/uploads/upload_cd347e3ea6e9506d8f224bd8686aa294.png)
9595

96-
コミットのメールアドレスの設定は、グローバルに効かせるほか、それぞれのリポジトリに対して個別で効かせることもできます。GitHub と Gitea のうちどちらか一方をメインで使っていく場合には、多く使う方のダミーアドレスをグローバルに設定しておいて、あまり使わない方のリポジトリには個別でローカル設定を書いておくとよいでしょう
96+
コミットのメールアドレスの設定は、グローバルに効かせるほか、それぞれのリポジトリに対して個別で効かせることもできます。GitHub と Gitea のうちどちらか一方をメインで使っていく場合には、多く使う方のダミーアドレスをグローバルに設定しておいて、あまり使わない方のリポジトリには個別で以下のようにローカル設定を書いておくとよいでしょう
9797

9898
```sh
9999
git config user.email ダミーメールアドレス # --global をつけない

docs/text/chapter-3/gitignore.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
# .gitignore
22

3-
既存のリポジトリをいくつか見て回っていると、よく .gitignore という名前のテキストファイルを目にします。簡単にいうと、これはリポジトリに載せないファイルの名簿です。
3+
既存のリポジトリをいくつか見て回っていると、よく `.gitignore` という名前のテキストファイルを目にします。簡単にいうと、これはリポジトリに載せないファイルの名簿です。
44

55
## .gitignore のはたらき
66

7-
.gitignore が持つ効果については実例を見た方が分かりやすいかも知れません。まず、リポジトリに .gitignore という名前(最初にピリオドをつける)の空のテキストファイルを作成し、そこに "secret.md" とだけ書いて変更をコミットしてしまいましょう。
7+
.gitignore が持つ効果については実例を見た方が分かりやすいかも知れません。まず、リポジトリに `.gitignore` という名前(最初にピリオドをつける)の空のテキストファイルを作成し、そこに `secret.md` とだけ書いて変更をコミットしてしまいましょう。
88

99
![](https://md.trap.jp/uploads/upload_afb00e41b7c969a1b867d51803f6f36d.png)
1010

11-
さらに secret.md という名前の空のテキストファイルを作成して編集します。
11+
さらに `secret.md` という名前の空のテキストファイルを作成して編集します。
1212

1313
![](https://md.trap.jp/uploads/upload_c42709799b91b87e60ae444c6c013b8a.png)
1414

1515
すると、変更を保存していつまで待っても『ステージされている変更』に secret.md の表示が出ず、コミットができなくなりました。エクスプローラータブでファイルの一覧を見直してみると、どうも secret.md だけファイル名の表示が暗くなっています。
1616

1717
![](https://md.trap.jp/uploads/upload_2c8d8f54e90d1c77f9668bdfdc7a0855.png)
1818

19-
これは先ほど作った .gitignore の効力です。リポジトリに .gitignore というファイルが含まれていると、Git は**そこに名前が書かれたファイルをすべてコミットから除外**します。"secret.md" と書かれたファイル .gitignore をリポジトリに追加したことで、secret.md は**作業ディレクトリの中に存在するにも拘らずリポジトリには含まれなくなった**のです。
19+
これは先ほど作った .gitignore の効力です。リポジトリに .gitignore というファイルが含まれていると、Git は**そこに名前が書かれたファイルをすべてコミットから除外**します。`secret.md` と書かれたファイル .gitignore をリポジトリに追加したことで、secret.md は**作業ディレクトリの中に存在するにも拘らずリポジトリには含まれなくなった**のです。
2020

2121
ちなみに、.gitignore はただファイル名を列挙するだけでなく、ディレクトリ名を書いてそこに含まれるファイルを丸ごと除外したり、同じ種類の(たとえば共通の拡張子を持つ)ファイルをいっぺんに除外したりすることもできます。
2222

@@ -47,19 +47,19 @@ node_modules
4747

4848
### モジュールの除外
4949

50-
ここからは Web 開発の多少込み入った話になります。2 行目の node_modules は Node.js を用いた開発において **パッケージがインポートされるディレクトリ** です。
50+
ここからは Web 開発の多少込み入った話になります。2 行目の node_modules は Node.js を用いた開発において **パッケージがダウンロードされるディレクトリ** です。
5151

52-
Web 分野に限らず、開発とは必ずしも全てを独力でなんとかする類のものではなく、先人が作ったプログラムのまとまり「パッケージ」をお借りしてシステムに組み込みながら進めていくことが一般的です。そのために Web 上からパッケージをインポートして管理するパッケージマネージャと呼ばれるソフトウェアがプログラミング言語ごとに存在します。ちなみに、パッケージマネージャは Git 同様に代表的な CLI ソフトウェアの一種です。
52+
Web 分野に限らず、開発とは必ずしも全てを独力でなんとかするのではなく、先人が作ったプログラムのまとまり「**パッケージ**」をお借りしてシステムに組み込みながら進めていくことが一般的です。そのために Web に公開されているパッケージをダウンロードして管理する「**パッケージマネージャ**」と呼ばれるソフトウェアがプログラミング言語ごとに存在します。ちなみに、パッケージマネージャは Git 同様に代表的な CLI ソフトウェアの一種です。
5353

54-
パッケージマネージャの基本的な役割は「**依存関係リストファイルに記されたパッケージをインポートする**」ことです。依存関係リストファイルとは必要なパッケージを決まった形式の箇条書きで記したテキストファイルのことです
54+
パッケージマネージャの基本的な役割は「**パッケージリストファイルに記されたパッケージを指定の場所にダウンロードする**」ことです。パッケージリストファイルとは、必要なパッケージの名前や ID が決まった形式で列記されたテキストファイルのことです
5555

56-
Node.js を用いた開発では npm(Node Package Manager)というパッケージマネージャが存在して、以下のようにコマンドを打てば「package.json に記されたパッケージをダウンロードして node_modules ディレクトリに追加」してくれます。
56+
Node.js を用いた開発では npm(Node Package Manager)というパッケージマネージャが存在して、package.json というパッケージリストファイルを参照しながらパッケージを管理します。以下のようにコマンドを打てば「package.json に記されたパッケージをダウンロードして node_modules ディレクトリに追加」してくれます。
5757

5858
```sh
5959
npm install # Node パッケージのインストール
6060
```
6161

62-
つまり、npm とリポジトリの中の package.json さえあれば各環境で必要なパッケージをインポートして揃えることができます。とすれば、その保存先である node_modules ディレクトリは必ずしもリポジトリに含める必要はないということになります。
62+
つまり、npm とリポジトリの中の package.json さえあれば各環境で必要なパッケージをダウンロードして揃えることができます。とすれば、その保存先である node_modules ディレクトリは必ずしもリポジトリに含める必要はないということになります。
6363

6464
:::tip 外部モジュールのとても雑な例え話
6565

@@ -69,9 +69,9 @@ npm install # Node パッケージのインストール
6969
- 貴重品 -> **オリジナルのソースコード**
7070
- 現地調達可能なもの -> **外部パッケージ**
7171
- 現地 -> **システムが動く環境**
72-
- 現地調達するもののメモ -> **依存関係リストファイル**
72+
- 現地調達するもののメモ -> **パッケージリストファイル**
7373

74-
対応させるならこんな感じでしょうか。外部パッケージは **システムが動く環境で / パッケージマネージャが / 依存関係リストファイルをもとに調達してくれる** ものなので **リポジトリに含める必要がない** という要点をおさえるために旅にたとえてみました。また行きたい。
74+
対応させるならこんな感じでしょうか。外部パッケージは **システムが動く環境で / パッケージマネージャが / パッケージリストファイルをもとに調達してくれる** ものなので **リポジトリに含める必要がない** という要点をおさえるために旅にたとえてみました。また行きたい。
7575
:::
7676

7777
というわけで .gitignore に node_modules と書かれています。node_modules はディレクトリ名なので、ここに含まれるパッケージを一薙ぎに除外してしまおうという寸法です。
@@ -102,7 +102,7 @@ npm install # Node パッケージのインストール
102102

103103
## 環境変数と機密情報の秘匿
104104

105-
traP Gitea 上のリポジトリは部員に対してのみ公開されますが、GitHub などのホスティングサービスを使う場合は Web 上に公開された Git リポジトリで開発を進めていくことも珍しくありません。それどころか、GitHub の無料会員は数年前までプライベートリポジトリを作ることが出来ませんでした
105+
traP Gitea 上のリポジトリは部員に対してのみ公開されますが、GitHub などのホスティングサービスを使う場合は Web 上に公開された Git リポジトリで開発を進めていくことも珍しくありません。それどころか、GitHub の無料会員は 2018 年までプライベートリポジトリを作ることが出来ませんでした
106106

107107
実行中のシステムが必要とする情報のうち、API トークン(パスワード)など外部に悪用されないように秘匿しておきたい文字列もよく環境変数として扱われます。実際に環境に依存するか否かはさておき、.gitignore の恩恵でリポジトリに含まれなくなった .env はこうした機密情報を置いておくにはうってつけの場所です。
108108

0 commit comments

Comments
 (0)