When using a catalog, you will often have a need to request the addition of new software packages that you have added or updated. While this can be done from the web UI after an alignment check, you can also do this from the command line when using a workflow that checks your alignment.
From web application
You can request new releases individually for your catalog by searching for a package from Catalogs > Packages. Identify the release you wish to request and select Request release.
If there are no standards violations, the request will be automatically approved. Otherwise, a task will be created for a catalog administrator to review the request
From command line
- To request packages, 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 to use as TEAM_NAME below
- From your repository's root directory run
tidelift request --project PROJECT_NAME --organization ORGANIZATION_NAME PACKAGE_MANAGER PACKAGE_NAME PACKAGE_RELEASE
. PROJECT_NAME is the name of the project as set up in Tidelift, PACKAGE_MANAGER is the package manager you are using (eg, maven, npm, etc), PACKAGE_NAME is the name of the package and RELEASE is the version of the package you wish to add. (project and organization are not required if a .tidelift file is found) - If you wish to request all of the packages that your project currently requires that aren't approved, you can request them all by running run
tidelift request --project PROJECT_NAME --organization ORGANIZATION_NAME --all
(project and organization are not required if a .tidelift file is found) - You will be given information about if the packages have been previously denied and then notified by email upon approval of the requested package releases
Seeing your requests
You can see what releases you have requested by running
tidelift request list
, this will show any outstanding requests that have still not been approved or denied. If you want to see a large list of what has been approved or denied from your user, you can run tidelift request list --approved
or tidelift request list --denied
(or see everything with tidelift request list --approved --denied --requested
)