Skip to content

Introduction

The document describes the steps to be performed in order to update the product-repo relationship entry in product catalogue database

How to update your repo to product association through component owner file

Execute following steps to use the component owner file to update product - repo relationship entry in database

  • Go to your repo's root folder

root folder

  • Remove the entry or update with a new product

component owner

  • Save and commit the file

A pipeline is scheduled to run daily at midnight UTC to fetch the data from component owner files in all repo in org. This pipeline has script to parse the data from file and update the database accordingly

This pipeline can also be triggered manually to immediately update the data

To see the details of the implementation of the utility go here

How to update your repo to product association through product catalogue file

An alternative way is available to update the product - repo relationship into the database. A central repo is created to store the data here. In the repo there is a productCatalogue json file per product

To update the data execute following steps

  • Create a branch of the repo here according to P&P
  • Go to productcatalogue folder inside the repo

product catalogue folder

  • Update the file with required information
  • Enter following details
  • "org" : name of the organization
  • "project" : name of the project
  • "repo" : name of the repo

product catalogue file

  • create a PR to merge the changes to main branch
  • The PR has to be approved by energizers team after validation

A pipeline is created which gets triggered on merge to productcatolgue repo. This pipeline has script to parse the files inside productCatalogue folder and update the database

To see the details of the implementation of the utility go here

Things to remember

  • In both flows ensure that files are valid jsons

Back to main page