Welcome to the New Relic One Catalog application submission process

Before Developer submits a PR

Actor(s)

• Developer

Step(s)

• Developer forks this nr1-catalog repository
• Developer reviews documentation on this website
• Developer preps their nerdpack based on the PR checklist to either add or update code
• Developer adds that repository as a git submodule under the apps directory in the following manner:

If adding a submodule

# assumed state: you've forked newrelic/nr1-catalog
# assumed state: git clone https://github.com/[YOUR_GITHUB_HANDLE]/nr1-catalog.git
cd nr1-catalog/apps
git submodule add [YOUR REPO URL]
# example: git submodule add https://github.com/newrelic/nr1-browser-analyzer.git
git commit -a -m "feat: Adding [YOUR REPO NAME] to nr1-catalog."
git push

Note: By convention, you must use the https URL for the git repository.

If updating a submodule to the latest commit

# assumed state: you've forked newrelic/nr1-catalog
# assumed state: git clone https://github.com/[YOUR_GITHUB_HANDLE]/nr1-catalog.git
cd nr1-catalog/apps/[YOUR REPO URL]
git pull
cd ..
git commit -a -m "feat: Updating [YOUR REPO NAME] to v. [YOUR REPO VERSION]."
git push

Outcomes

• Nerdpack repository is prepared for a Pull Request to the newrelic/nr1-catalog repository.

Next Step(s)

• Submitting a Pull Request to the newrelic/nr1-catalog repository

Developer submits a PR

Actor(s)

• Developer

Step(s)

In this phase, the Developer submits a pull request from their forked instance of the nr1-catalog to newrelic/nr1-catalog repository.

Outcomes

• PR is structurally verified via automation in newrelic/nr1-catalog
• Nerdpack is ready for the Verify phase
• Developer can track the status and queue depth of their Pull Request in GitHub

Next Step(s)

• Maintainers and Reviewers execute a multi-phased review of the Nerdpack

Verify the Nerdpack

Actor(s)

• Developer
• Reviewer
• Maintainer

Step(s)

Based on the level of change (new Nerdpacks require more verification), Maintainers shepherd the submitted nerdpack (submitted to the newrelic/nr1-catalog repository as a git submodule) through a number of standards set by expert Reviewers. This phase can take hours or days, depending on the size of the Nerdpack and level of change.

Verification covers the following

• Security verification
• Code verification
• Design verification
• Documentation verification

In each phase, remedian may be requested and/or required of the Developer by the Reviewer(s), as communicated through the GitHub Pull Request.

Outcomes

• Pull Request is rejected and closed
• Pull Request is ready for Approval and merge to master

Final Approval of the Nerdpack

Stakeholders

• Approver
• Maintainer

Step(s)

• Maintainer requests via GitHub Pull Request Review features for Approver to provide official sign off
• Approver indicates approval via GitHub Pull Request Review features approval for deployment

Outcomes

• Approved, accepted Pull Request

Deployment to the New Relic One Catalog

Actor(s)

• Maintainer

Step(s)

Once approved, the Maintainer will merge the nerdpack (attached as a git submodule) to the master branch of newrelic/nr1-catalog, and automation will perform the following:

• Build the application
• Assign/retrieve the application's global catalog uuid
• Publish the application to New Relic One
• Update the New Relic One Catalog service with the application's metadata