Checking catalog alignment

If you are using a Tidelift catalog, you can check alignment (i.e. if a project is using only approved package releases) quickly using Tidelift CLI. Using tidelift alignment does not update the Bill of Materials for the project and only requires a user API key. To update the BoM for the project and create a record of the alignment, use tidelift alignment save; this is ideal for CI/CD as it will require a project API key.

Checking Local Build Alignment

  1. To check for your catalog alignment, you will first need to have a user API key to authenticate to the API. Be sure to note your team name when downloading your API key.
  2. From your project's root directory run tidelift alignment --project PROJECT_NAME --organization ORGANIZATION_NAME. PROJECT_NAME is the name of the project as set up in Tidelift.
  3. From your project's root directory, run tidelift alignment
  4. Once the alignment check completes, you will see the percent of package releases in the current project that are approved in the organization's catalog.
  5. If any package releases are not available, you will see if you should request them using tidelift request --all and/or why they were previously denied.

Checking Alignment as part of Continuous Integration

To check for your catalog alignment as part of your continuous integration process, you will need to create a project API key. Once a project API key is stored in your CI/CD system, you can run  tidelift alignment save . This will update the Bill of Materials for the project and create a record of the alignment.

Still need help? Contact Us Contact Us