2. Gitリポジトリへのコミット (handson-cli-repository)

作業の目的 [why]

Gitリポジトリ"handson-cli-repository"のブランチ"feature/feature-handson-cli"にコミットします。

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

完了条件 [after]

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

完了条件1
Gitリポジトリ"handson-cli-repository"にブランチ"feature/feature-handson-cli"のコミットログにコミット結果が存在する。

事前条件 [before]

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

事前条件1
開発用ディレクトリ"${HOME}/environment"が存在する。
事前条件2
開発用ディレクトリ"${HOME}/environment"にGitリポジトリ"handson-cli-repository"が存在する。
事前条件3
開発用ディレクトリ"${HOME}/environment"のGitリポジトリ"handson-cli-repository"のカレントブランチが"feature/feature-handson-cli"である。

作業対象 [what]

  • ローカル環境

標準時間(合計)

8分

パラメータ設定

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

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

作業開始には、以下が全て揃っていることが必要です。

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

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

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

  • コミットするGitリポジトリの名称です。
  • 今回は"handson-cli-repository"とします。

リソース3: ブランチ名

  • コミットするブランチの名称です。
  • 今回は"feature/feature-handson-cli"とします。

リソース4: コミットメッセージ

  • コミットのメッセージです。
  • 今回は"Added new feature."とします。

パラメータの指定

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

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

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

変数の設定:

DIR_DEVELOP="${HOME}/environment"

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

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

変数の設定:

GIT_REPOSITORY_NAME='handson-cli-repository'

0.3. ブランチ名の指定

ブランチ名を指定します。

変数の設定:

GIT_BRANCH_NAME='feature/feature-handson-cli'

0.4. コミットメッセージの指定

コミットメッセージを指定します。

変数の設定:

GIT_COMMIT_MSG="Added new feature."

パラメータの保存

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

変数の設定:

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

結果(例):

${HOME}/tmp/parameter-handson-cli/2019-04-30-git-commit-create.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}"
  # 0.3. GIT_BRANCH_NAME:"feature/feature-handson-cli"
         GIT_BRANCH_NAME="${GIT_BRANCH_NAME}"
  # 0.4. GIT_COMMIT_MSG:"Added new feature."
         GIT_COMMIT_MSG="${GIT_COMMIT_MSG}"

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: 開発用ディレクトリ"${HOME}/environment"のGitリポジトリ"handson-cli-repository"のカレントブランチが"feature/feature-handson-cli"である。

「開発用ディレクトリ"${HOME}/environment"のGitリポジトリ"handson-cli-repository"のカレントブランチが"feature/feature-handson-cli"である。」ことを確認します。

コマンド:

git rev-parse \
  --abbrev-ref HEAD

結果(例):

feature/feature-handson-cli

異なる場合は、ブランチをチェックアウトします。

コマンド:

git checkout ${GIT_BRANCH_NAME}

結果(例):

Branch feature/feature-handson-cli set up to track remote branch feature/feature-handson-cli from <以前のカレントブランチ>.
Switched to a new branch 'feature/feature-handson-cli'

2. 主処理

ステージへのファイル登録

コマンド:

git add .

結果(例):

(出力なし)

Gitリポジトリへのコミット

コマンド:

git commit -m "${GIT_COMMIT_MSG}"

結果(例):

(略)

3. 後処理

完了条件の確認

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

完了条件1: Gitリポジトリ"handson-cli-repository"にブランチ"feature/feature-handson-cli"のコミットログにコミット結果が存在する。

「Gitリポジトリ"handson-cli-repository"にブランチ"feature/feature-handson-cli"のコミットログにコミット結果が存在する。」ことを確認します。

コマンド:

git log \
  --pretty=format:"%s" \
  -1

結果(例):

Added new feature.

ブランチのオリジンリポジトリへのプッシュ

コマンド:

git push origin ${GIT_BRANCH_NAME}

結果(例):

Total 0 (delta 0), reused 0 (delta 0)
To <GitリポジトリオリジンURL>
 * [new branch]      feature/feature-handson-cli -> feature/feature-handson-cli

完了