1. 作業用ディレクトリ(Gitワークツリー)の作成 (CodeCommit: handson-cli-repository)

作業の目的 [why]

CodeCommitリポジトリ"handson-cli-repository"をローカル環境に転送して、作業用ディレクトリ(Gitワークツリー)を作成します。

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

完了条件 [after]

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

完了条件1
CodeCommitリポジトリ"handson-cli-repository"の開発用ディレクトリ(Gitワークツリー)が開発用ディレクトリ"${HOME}/environment"に存在する。

事前条件 [before]

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

事前条件1
CodeCommitリポジトリ"handson-cli-repository"が存在する。
事前条件2
開発用ディレクトリ"${HOME}/environment"が存在する。
事前条件3
CodeCommitリポジトリ"handson-cli-repository"の開発用ディレクトリ(Gitワークツリー)が開発用ディレクトリ"${HOME}/environment"に存在しない。

作業対象 [what]

  • CodeCommitサービス

標準時間(合計)

8分

パラメータ設定

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

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

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

リソース1: CodeCommitリポジトリ名

  • 作成するCodeCommitリポジトリの名称です。
  • 今回は"handson-cli-repository"とします。

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

  • 今回は"${HOME}/environment"を開発用ディレクトリとします。

ディレクトリが存在することを確認します。

コマンド:

ls -d ${HOME}/environment

結果(例:存在する場合):

${HOME}/environment

存在しない場合は作成します。

コマンド:

mkdir -p ${HOME}/environment

パラメータの指定

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

0.0. リージョンの指定

変数の設定

export AWS_DEFAULT_REGION='ap-northeast-1'

0.1. CodeCommitリポジトリ名の指定

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

変数の設定:

CODEC_REPOSITORY_NAME='handson-cli-repository'

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

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

変数の設定:

DIR_DEVELOP="${HOME}/environment"

パラメータの保存

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

変数の設定:

DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli"
FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-codecommit-repository_clone-read-expand-empty.env" \
  && echo ${FILE_PARAMETER}

結果(例):

${HOME}/tmp/parameter-handson-cli/2019-04-30-codecommit-repository_clone-read-expand-empty.env

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

変数の確認:

cat << EOF > ${FILE_PARAMETER}

  # 0.0. AWS_DEFAULT_REGION:"ap-northeast-1"
         AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}"

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

EOF

cat ${FILE_PARAMETER}

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

タスクの実施

タスク標準時間:6分

1. 前処理

1.1. 処理対象の状態確認

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

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

事前条件1: CodeCommitリポジトリ"handson-cli-repository"が存在する。

「CodeCommitリポジトリ"handson-cli-repository"が存在する。」ことを確認します。

コマンド:

aws codecommit list-repositories \
  --query "repositories[?repositoryName == \`${CODEC_REPOSITORY_NAME}\`].repositoryName" \
  --output text

結果(例):

handson-cli-repository

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

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

コマンド:

ls -d ${DIR_DEVELOP}

結果(例):

${HOME}/environment

事前条件3: CodeCommitリポジトリ"handson-cli-repository"の開発用ディレクトリ(Gitワークツリー)が開発用ディレクトリ"${HOME}/environment"に存在しない。

「CodeCommitリポジトリ"handson-cli-repository"の開発用ディレクトリ(Gitワークツリー)が開発用ディレクトリ"${HOME}/environment"に存在しない。」ことを確認します。

コマンド:

! ls -d ${DIR_DEVELOP}/${CODEC_REPOSITORY_NAME}

結果(例):

ls: ${HOME}/environment/handson-cli-repository: No such file or directory

1.2. 主処理に必要な情報の取得

クローンURLの取得

コマンド:

CODEC_CLONE_URL=$( \
  aws codecommit get-repository \
  --repository-name ${CODEC_REPOSITORY_NAME} \
  --query 'repositoryMetadata.cloneUrlSsh' \
  --output text \
) \
  && echo ${CODEC_CLONE_URL}

結果(例):

ssh://git-codecommit.ap-northeast-1.amazonaws.com/v1/repos/handson-cli-repository

2. 主処理

空のCodeCommitリポジトリを作業用ディレクトリにクローンし、masterブランチを作成します。

CodeCommitリポジトリのclone

コマンド:

cd ${DIR_DEVELOP}

コマンド:

git clone ${CODEC_CLONE_URL}

結果(例):

Cloning into 'handson-cli-repository'...
Warning: Permanently added the RSA host key for IP address 'xxx.xxx.xxx.xxx' to the list of known hosts.
warning: You appear to have cloned an empty repository.

masterブランチへのReadmeファイルの登録

masterブランチを作成するために、Readmeファイルをリポジトリに登録します。

コマンド:

cd ${DIR_DEVELOP}/${CODEC_REPOSITORY_NAME}/

結果(例):

(出力なし)

コマンド:

echo "# ${CODEC_REPOSITORY_NAME}" \
  > README.md

結果(例):

(出力なし)

コマンド:

git add README.md

結果(例):

(出力なし)

masterブランチへの.gitignoreファイルの登録

コマンド:

touch .gitignore

結果(例):

(出力なし)

コマンド:

git add .gitignore

結果(例):

(出力なし)

masterブランチへのコミット

コマンド:

git commit -m 'Initial commit' \
  && git push

結果(例):

[master (root-commit) xxxxxxx] Initial commit
 2 file changed, 1 insertion(+)
 create mode 100644 README.md
Counting objects: 3, done.
Writing objects: 100% (3/3), 233 bytes | 233.00 KiB/s, done.
Total 3 (delta 0), reused 0 (delta 0)
To ssh://git-codecommit.ap-northeast-1.amazonaws.com/v1/repos/handson-cli-repository
 * [new branch]      master -> master

3. 後処理

完了条件の確認

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

完了条件1: CodeCommitリポジトリ"handson-cli-repository"の開発用ディレクトリ(Gitワークツリー)が開発用ディレクトリ"${HOME}/environment"に存在する。

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

コマンド:

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

結果(例):

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

完了