Tutorial: Pull from a package repository

Open the CodeCatalyst console at https://codecatalyst.aws/.

Navigate to your project, codecatalyst-package-project.

In the navigation pane, choose Code, and then choose Source repositories.

Choose Add repository, and then choose Create repository.

In Repository name, enter:

hello-world-app

Choose Create.

In the navigation pane, choose Packages.

Choose Create package repository.

In Repository name, enter:

codecatalyst-package-repository

Choose + Select upstream repositories.

Choose Gateway repositories.

In the npm-public-registry-gateway box, choose Create.

Choose Select.

Choose Create.

CodeCatalyst creates a package repository called codecatalyst-package-repository which is connected to a gateway repository. The gateway repository is connected to the npmjs.com registry.

In the navigation pane, choose Code, and then choose Dev Environments.

Near the top choose Create Dev Environment, and then choose AWS Cloud9 (in browser).

Make sure that Repository is set to hello-world-app and Existing branch is set to main. Choose Create.

Your Dev Environment launches in a new browser tab, and your repository (hello-world-app) is cloned into it.

Leave both CodeCatalyst browser tabs open, and go to the next procedure.

Go to your Dev Environment.

At the terminal prompt, change to the hello-world-app source repository root directory:

cd hello-world-app

Initialize a Node.js project:

npm init -y

The initialization creates a package.json file in the root directory of hello-world-app.

Connect the npm client in your Dev Environment to your CodeCatalyst package repository:

Import lodash version 4.17.20:

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

npm looks for lodash version 4.17.20 in the following locations, in the following order:

npm imports lodash into the gateway repository, the CodeCatalyst package repository, and the Dev Environment.

npm also updates your package.json file with the lodash dependency, and creates a node_modules directory containing lodash and all its dependencies.

Test that lodash was successfully imported to your Dev Environment. Enter:

npm list

The following message appears, indicating a successful import:

`-- lodash@4.17.20

(Optional) Open hello-world-app/package.json and verify that the lines in red bold were added:

{
  "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"
  }
}

In /hello-world-app, create a file called index.js with the following contents:

// 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);

Switch to the CodeCatalyst console.

In the navigation pane, choose Packages.

Choose npm-public-registry-gateway.

Make sure lodash is displayed. The Latest version column indicates 4.17.20.

Repeat this procedure for the codecatalyst-package-repository. You might need to refresh the browser window to see the imported package.

Switch to your Dev Environment.

Make sure you're still in the hello-world-app directory, and then run the application:

node index.js

A Hello World message appears. Node.js ran the application using the lodash package that you downloaded to your Dev Environment in a previous step.

Ignore the node_modules directory. Enter:

echo "node_modules/" >> .gitignore

It is a best practice to avoid committing this directory. Also, committing this directory will interfere with later steps in this tutorial.

Add, commit, and push:

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

The 'Hello World' application and project files are added to your source repository.

Switch to the CodeCatalyst console.

In the navigation pane, choose CI/CD, and then choose Workflows.

Choose Create workflow.

For Source repository, choose hello-world-app.

For Branch, choose main.

The workflow definition file is will be created in the chosen source repository and branch.

Choose Create.

Choose YAML near the top.

Delete the YAML sample code.

Add the following YAML code:

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

In the preceding code, replace codecatalyst-package-repository with the name of the CodeCatalyst package repository that you created in Step 2: Create the CodeCatalyst and gateway package repositories.

For information about the properties in this file, see the Build and test actions YAML.

(Optional) Choose Validate to make sure the YAML code is valid before committing.

Choose Commit.

On the Commit workflow dialog box, enter the following:

1. For Workflow file name, keep the default, codecatalyst-package-workflow.

2. For Commit message, enter:

   add initial workflow file

3. For Repository, choose hello-world-app.

4. For Branch name, choose main.

5. Choose Commit.

You have now created a workflow.

Next to the workflow you just created (codecatalyst-package-workflow), choose Actions and then choose Run.

A workflow run starts.

In the green notification at the top, on the right, choose the link to the run. The link looks similar to View Run-1234.

A workflow diagram appears, showing who started the run and the RunHelloWorldApp action.

Choose the RunHelloWorldApp action box to watch the action's progress.

When the run finishes, go to Step 5: Verify the workflow.

In the workflow diagram, choose the RunHelloWorldApp box.

A list of log messages appear.

Expand the node index.js log message.

The following message appears:

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

The appearance of Hello Word (instead of hello-world) indicates that the lodash dependency was successfully used.

Expand the npm list log.

A message similar to the following appears:

└── lodash@4.17.20

This message indicates that lodash version 4.17.20 was downloaded to the Docker image running the workflow action.

In the navigation pane, choose Packages.

Choose npm-publish-registry-gateway.

Choose lodash.

Near the top, choose Origin controls.

Under Upstream, choose Block.

Choose Save.

You have now blocked imports into your gateway repository (and downstream repositories and computers) from npmjs.com.

Switch to your Dev Environment.

Pull the codecatalyst-package-workflow.yaml file that you created using the CodeCatalyst console earlier:

git pull

Open /hello-world-app/package.json.

Change the lodash version to 4.17.21 as shown in red bold:

{
  "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"
  }
}

There is now a mismatch between the version in the package.json file (4.17.21) and the version in the gateway and CodeCatalyst package repositories (4.17.20).

Add, commit, and push:

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

Run the workflow with the version mismatch:

Verify that the workflow failed:

In the navigation pane, choose Packages.

Choose npm-publish-registry-gateway.

Choose lodash.

Near the top, choose Origin controls.

Under Upstream, choose Allow.

Choose Save.

You have now unblocked imports of lodash.

Your workflow can now import version 4.17.21 of lodash.

Run your workflow again. This time the workflow should succeed because the import of 4.17.21 should now work. To run the workflow again:

Verify that version 4.17.21 was imported to your CodeCatalyst and gateway repositories:

Delete the codecatalyst-package-project:

1. In the CodeCatalyst console, nagivate to the codecatalyst-package-project project if you're not there already.

2. In the navigation pane, choose Project settings.

3. Choose Delete project, enter delete, and choose Delete project.

   CodeCatalyst deletes all project resources, including the source, gateway, and CodeCatalyst package repositories. The Dev Environment is also deleted.

Delete the PAT token:

1. Choose your username on the right, and then choose My settings.

2. Under Personal access tokens, choose the token you created in this tutorial and choose Delete.