2.2. .gitignoreの更新 (handson-cli-repository)

作業の目的 [why]

Gitリソース"handson-cli-repository"を作成します。

完了条件/事前条件 [設計者用情報]

完了条件 [after]

主処理は、以下を満たしたときに成功したものとします。

完了条件1
Gitリポジトリ"handson-cli-repository"の.gitignoreファイルが更新されている。

事前条件 [before]

主処理の実施は、以下の状態であることを前提とします。

事前条件1
開発用ディレクトリ"${HOME}/environment"が存在する。
事前条件2
開発用ディレクトリ"${HOME}/environment"にGitリポジトリ"handson-cli-repository"が存在する。
事前条件3
Gitリポジトリ"handson-cli-repository"に.gitignoreファイルが存在する。

作業対象 [what]

  • ローカル環境

標準時間(合計)

8分

タスク実施の前提条件

作業権限条件 [who]

本作業は、以下の作業権限を有する人が行います。

作業権限条件: (特になし)

特になし

作業環境条件 [where]

本作業は、以下の作業環境で行います。

作業環境条件1: OSとバージョン

本手順は、Amazon Linux "Amazon Linux AMI release 2018.03"以降のOS環境での実施を前提としています。

コマンド:

cat /etc/issue | head -1

結果(例):

Amazon Linux AMI release 2018.03

作業環境条件2: シェルとバージョン

本手順は、bash "4.2.46(2)-release"以降のシェル環境での実施を前提としています。

コマンド:

bash --version -v | head -1

結果(例):

GNU bash, バージョン 4.2.46(2)-release (x86_64-redhat-linux-gnu)

作業開始条件 [when]

以下を全て満たしているとき、作業を開始します。

  • 開始の指示があった場合。

パラメータ設定

パラメータ設定の標準時間:2分

作業に必要なモノ・情報 [resource]

リソース1: 開発用ディレクトリ

開発用ディレクトリ"${HOME}/environment"です。

リソース2: Gitリポジトリ名

  • ブランチを作成するGitリポジトリの名称です。
  • 今回は"handson-cli-repository"とします。

パラメータの指定

作業に必要なパラメータを変数に格納をします。

0.1. 開発用ディレクトリの指定

開発用ディレクトリ名を指定します。

変数の設定:

DIR_DEVELOP="${HOME}/environment"

0.2. Gitリポジトリ名の指定

Gitリポジトリ名を指定します。

変数の設定:

GIT_REPOSITORY_NAME='handson-cli-repository'

パラメータの保存

設定されている変数の保存先となるファイル名を指定します。

変数の設定:

DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli"
FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-git-dot_gitignore-update-expand-venv.env" \
  && echo ${FILE_PARAMETER}

結果(例):

${HOME}/tmp/parameter-handson-cli/2019-04-30-git-dot_gitignore-update-expand-venv.env

各変数に正しいパラメータ値が格納されていることを確認しながら保存します。

変数の確認:

cat << EOF > ${FILE_PARAMETER}

  # 0.1. DIR_DEVELOP:"${HOME}/environment"
         DIR_DEVELOP="${DIR_DEVELOP}"
  # 0.2. GIT_REPOSITORY_NAME:"handson-cli-repository"
         GIT_REPOSITORY_NAME="${GIT_REPOSITORY_NAME}"

EOF
cat ${FILE_PARAMETER}

下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号に戻って変数の設定を行います。

タスクの実施

課題

(未検証)

タスク標準時間:6分

1. 前処理

処理対象の状態確認

主処理の実施は、以下の状態であることを前提とします。

前提と異なることが判明した場合、直ちに処理を中止します。

事前条件1: 開発用ディレクトリ"${HOME}/environment"が存在する。

「開発用ディレクトリ"${HOME}/environment"が存在する。」ことを確認します。

コマンド:

ls -d ${DIR_DEVELOP}

結果(例):

${HOME}/environment

事前条件2: 開発用ディレクトリ"${HOME}/environment"にGitリポジトリ"handson-cli-repository"が存在する。

「開発用ディレクトリ"${HOME}/environment"にGitリポジトリ"handson-cli-repository"が存在する。」ことを確認します。

コマンド:

ls -d ${DIR_DEVELOP}/${GIT_REPOSITORY_NAME}

結果(例):

${HOME}/environment/handson-cli-repository

Gitリポジトリ(ワークツリー)へ移動します。

コマンド:

cd ${DIR_DEVELOP}/${GIT_REPOSITORY_NAME}/

結果(例):

(出力なし)

事前条件3: Gitリポジトリ"handson-cli-repository"に.gitignoreファイルが存在する。

「Gitリポジトリ"handson-cli-repository"に.gitignoreファイルが存在する。」ことを確認します。

コマンド:

ls .gitignore

結果(例):

.gitignore

2. 主処理

.gitignoreファイルの更新

コマンド:

cat << EOF >> .gitignore
venv
EOF

3. 後処理

完了条件の確認

主処理は、以下を満たしたときに成功したものとします。

完了条件1: Gitリポジトリ"handson-cli-repository"の.gitignoreファイルが更新されている。

「Gitリポジトリ"handson-cli-repository"の.gitignoreファイルが更新されている。」ことを確認します。

コマンド:

git diff .gitignore

結果(例):

diff --git a/.gitignore b/.gitignore
index e69de29..5ceb386 100644
--- a/.gitignore
+++ b/.gitignore
@@ -0,0 +1 @@
+venv

完了