チュートリアル: パッケージリポジトリからプルする

https://codecatalyst.aws/ で CodeCatalyst コンソールを開きます。

プロジェクト「codecatalyst-package-project」に移動します。

ナビゲーションペインで [コード] を選択してから、[ソースリポジトリ] を選択します。

[リポジトリの追加] を選択し、[リポジトリの作成] を選択します。

[リポジトリ名] に次のように入力します。

hello-world-app

[Create] (作成) を選択します。

ナビゲーションペインで、[Packages (パッケージ)] を選択します。

[パッケージリポジトリの作成] を選択します。

[リポジトリ名] に次のように入力します。

codecatalyst-package-repository

[+アップストリームリポジトリを選択] を選択します。

[ゲートウェイリポジトリ] を選択します。

[npm-public-registry-gateway] ボックスで、[作成] を選択します。

[選択] を選びます。

[Create] (作成) を選択します。

CodeCatalyst により、ゲートウェイリポジトリに接続されている codecatalyst-package-repository というパッケージリポジトリが作成されます。ゲートウェイリポジトリは npmjs.com レジストリに接続されています。

ナビゲーションペインで、[コード]、[開発環境] の順に選択します。

上部近くで [開発環境を作成] を選択し、[AWS Cloud9 (ブラウザで)] を選択します。

[リポジトリ] が hello-world-app に設定され、[既存のブランチ] が main に設定されていることを確認します。[Create] (作成) を選択します。

開発環境が新しいブラウザタブで起動し、リポジトリ (hello-world-app) のクローンがそこに作成されます。

両方の CodeCatalyst ブラウザタブを開いたままにして、次の手順に進みます。

開発環境に移動します。

ターミナルプロンプトで、hello-world-app ソースリポジトリのルートディレクトリに変更します。

cd hello-world-app

Node.js プロジェクトを初期化します。

npm init -y

初期化により、hello-world-app のルートディレクトリに package.json ファイルが作成されます。

開発環境の npm クライアントを CodeCatalyst パッケージリポジトリに接続します。

lodash バージョン 4.17.20 をインストールします。

npm install lodash@v4.17.20 --save --save-exact

npm は、次の場所で lodash バージョン 4.17.20 を次の順序で検索します。

npm は、lodash をゲートウェイリポジトリ、CodeCatalyst パッケージリポジトリ、開発環境にインポートします。

npm は、lodash 依存関係を使用して package.json ファイルも更新し、lodash とそのすべての依存関係を含む node_modules ディレクトリを作成します。

lodash が開発環境に正常にインポートされたことを確認します。次のとおりに入力します。

npm list

インポートが成功したことを示す次のメッセージが表示されます。

`-- lodash@4.17.20

(オプション) hello-world-app/package.json を開き、赤い太字の行が追加されていることを確認します。

{
  "name": "hello-world-app",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  dependencies": {
    "lodash": "4.17.20"
  }
}

/hello-world-app に「index.js」という名前のファイルを次の内容で作成します。

// Importing lodash library
const _ = require('lodash');

// Input string
const inputString = 'hello-world';

// Transforming the string using lodash
const transformedString = _.startCase(inputString.replace('-', ' '));

// Outputting the transformed string to the console
console.log(transformedString);

CodeCatalyst コンソールに切り替えます。

ナビゲーションペインで、[Packages (パッケージ)] を選択します。

[npm-public-registry-gateway] を選択します。

lodash が表示されていることを確認します。[最新バージョン] の列には 4.17.20 が表示されます。

codecatalyst-package-repository でこの手順を繰り返します。インポートされたパッケージを表示するには、ブラウザウィンドウを再読み込みする必要があるかもしれません。

開発環境に切り替えます。

引き続き hello-world-app ディレクトリにいることを確認し、アプリケーションを実行します。

node index.js

Hello World メッセージが表示されます。Node.js は、前のステップで開発環境にダウンロードした lodash パッケージを使用してアプリケーションを実行しました。

node_modules ディレクトリを無視します。次のとおりに入力します。

echo "node_modules/" >> .gitignore

このディレクトリをコミットしないことをお勧めします。また、このディレクトリをコミットすると、このチュートリアルの後のステップに支障をきたします。

追加、コミット、プッシュ:

git add .
git commit -m "add the Hello World application"
git push

「Hello World」アプリケーションファイルとプロジェクトファイルがソースリポジトリに追加されます。

CodeCatalyst コンソールに切り替えます。

ナビゲーションペインで [CI/CD]、[ワークフロー] の順に選択します。

[ワークフローを作成] を選択します。

[ソースリポジトリ] で、hello-world-app を選択します。

[ブランチ] で、main を選択します。

ワークフロー定義ファイルは、選択したソースリポジトリとブランチに作成されます。

[Create] (作成) を選択します。

上部付近の [YAML] を選択します。

YAML サンプルコードを削除します。

次の YAML コードを追加します。

Name: codecatalyst-package-workflow
SchemaVersion: "1.0"

# Required - Define action configurations.
Actions:
  RunHelloWorldApp:
    # Identifies the action. Do not modify this value.
    Identifier: aws/build@v1
    Compute:
      Type: Lambda
    Inputs:
      Sources:
        - WorkflowSource # This specifies your source repository. 
    Configuration:
      Steps:
        - Run: npm install
        - Run: npm list
        - Run: node index.js
      Container: # This specifies the Docker image that runs the action.
        Registry: CODECATALYST
        Image: CodeCatalystLinuxLambda_x86_64:2024_03
    Packages:
      NpmConfiguration:
        PackageRegistries:
          - PackagesRepository: codecatalyst-package-repository

上記のコードで、codecatalyst-package-repository を、「ステップ 2: CodeCatalyst パッケージリポジトリとゲートウェイパッケージリポジトリを作成する」で作成した CodeCatalyst パッケージリポジトリの名前に置き換えます。

このファイルのプロパティの詳細については、「ビルドおよびテストアクション YAML」を参照してください。

(任意) [検証] を選択して、コミットする前に YAML コードが有効であることを確認します。

[コミット] を選択します。

[ワークフローをコミット] ダイアログボックスで、次のように入力します。

1. [ワークフローファイル名] は、デフォルトの「codecatalyst-package-workflow」のままにします。

2. [コミットメッセージ] には、次のように入力します。

   add initial workflow file

3. [リポジトリ] で、[hello-world-app] を選択します。

4. [ブランチ名] で、[main] を選択します。

5. [コミット] を選択します。

これでワークフローが作成されました。

先ほど作成したワークフロー (codecatalyst-package-workflow) の横にある [アクション] を選択し、[実行] を選択します。

ワークフローの実行が開始されます。

右上の緑色の通知で、実行へのリンクをクリックします。リンクは View Run-1234 の形式で表示されます。

ワークフロー図が表示され、実行を開始したユーザーと RunHelloWorldApp アクションが表示されます。

[RunHelloWorldApp] アクションボックスを選択して、アクションの進行状況を確認します。

実行が完了したら、「ステップ 5: ワークフローを検証する」に進みます。

ワークフロー図で、[RunHelloWorldApp] ボックスを選択します。

ログメッセージのリストが表示されます。

node index.js ログメッセージを展開します。

次のメッセージが表示されます。

[Container] 2024/04/24 21:15:41.545650 Running command node index.js
Hello World

hello-world ではなく Hello Word と表示されていることから、lodash 依存関係が正常に使用されたことがわかります。

npm list ログを展開します。

次のようなメッセージが表示されます。

└── lodash@4.17.20

このメッセージは、ワークフローアクションを実行している Docker イメージに lodash バージョン 4.17.20 がダウンロードされたことを示しています。

ナビゲーションペインで、[Packages (パッケージ)] を選択します。

[npm-publish-registry-gateway] を選択します。

lodash を選択してください。

上部付近で、[オリジンコントロール] を選択します。

[アップストリーム] で、[ブロック] を選択します。

[Save] を選択します。

これで、npmjs.com からゲートウェイリポジトリ (およびダウンストリームリポジトリとコンピュータ) へのインポートがブロックされました。

開発環境に切り替えます。

CodeCatalyst コンソールを使用して以前に作成した codecatalyst-package-workflow.yaml ファイルをプルします。

git pull

/hello-world-app/package.json を開きます。

赤の太字で示されているように、lodash のバージョンを 4.17.21 に変更します。

{
  "name": "hello-world-app",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "dependencies": {
    "lodash": "4.17.21"
  }
}

これで、package.json ファイル内のバージョン (4.17.21) とゲートウェイリポジトリおよび CodeCatalyst パッケージリポジトリ内のバージョン (4.17.20) が一致しなくなりました。

追加、コミット、プッシュ:

git add .
git commit -m "update package.json to use lodash 4.17.21"
git push

バージョンが一致しない状態でワークフローを実行します。

ワークフローが失敗したことを確認します。

ナビゲーションペインで、[Packages (パッケージ)] を選択します。

[npm-publish-registry-gateway] を選択します。

lodash を選択してください。

上部付近で、[オリジンコントロール] を選択します。

[アップストリーム] で、[許可] を選択します。

[Save] を選択します。

これで、lodash のインポートのブロックが解除されました。

ワークフローで lodash のバージョン 4.17.21 をインポートできるようになりました。

ワークフローを再度実行します。4.17.21 のインポートが機能するようになったため、今回はワークフローが成功するはずです。ワークフローを再び実行するには:

バージョン 4.17.21 が CodeCatalyst およびゲートウェイリポジトリにインポートされたことを確認します。

codecatalyst-package-project を削除する:

1. CodeCatalyst コンソールで、まだ codecatalyst-package-project プロジェクトにいない場合はプロジェクトに移動します。

2. ナビゲーションペインで、[プロジェクト設定] を選択します。

3. [プロジェクトの削除] を選択し、「delete」と入力し、[プロジェクトの削除] を選択します。

   CodeCatalyst は、ソースリポジトリ、ゲートウェイリポジトリ、CodeCatalyst パッケージリポジトリを含むすべてのプロジェクトリソースを削除します。開発環境も削除されます。

PAT トークンを削除する:

1. 右側のユーザー名を選択し、[マイ設定] を選択します。

2. [個人用アクセストークン] で、このチュートリアルで作成したトークンを選択し、[削除] を選択します。