From 09d706a200d1fd3e7375ad8d8742dbf10bff2630 Mon Sep 17 00:00:00 2001
From: SIY1121 <sota.0512.0213@gmail.com>
Date: Fri, 5 Mar 2021 16:30:28 +0000
Subject: [PATCH] update: README

---
 README.md | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 2b5650a..1b65741 100644
--- a/README.md
+++ b/README.md
@@ -45,17 +45,27 @@ HelloService@localhost:50051>
 
 ```
 
+# GitHub Actions
+- `.github/workflows/test.yml` pushされるとテストを実行する
+- `.github/workflows/release.yml` GitHub上でリリースをPublishするとDockerImageをビルドし、GHCRにプッシュする。
+
 # 必要変更箇所
 
-Dockerfile L17
+1. Dockerfile L17
 ```dockerfile
 LABEL org.opencontainers.image.source https://github.com/twin-te/grpc-ts-template
 ```
 後ろのurlを自分のレポジトリのurlに変更する。（DockerImageとレポジトリの紐付けを行う）
 
-.github/workflows/release.yml L17
+2. .github/workflows/release.yml L17
 ```yml
 run: echo "TAG_NAME=ghcr.io/twin-te/grpc-ts-template:${GITHUB_REF#refs/*/}" >> $GITHUB_ENV
 ```
 TAG_NAME=ghcr.io/twin-te/{自分のレポジトリ名} に変更する（GitHubContainerRegistryにプッシュするときに使う）
 
+3. GitHubのSettings > Secrets > New repository secret で以下の環境変数を登録（GitHubAction用）
+
+|名前|説明|
+|:---|:---|
+|CR_PAT| GitHubContainerRegistry:write の権限を持ったPersonalAccessToken|
+|CR_USER|PersonalAccessTokenを作ったユーザー名|
\ No newline at end of file