Guidelines for Component Lookup
When possible, use the Forge or URL search for the most targeted search results, and use the Keyword search in other cases.
|
•
|
Use the Forge option if you know the names of the component’s forge and third-party project/repository. |
|
•
|
Use the URL option if you know the URL of the forge containing the components you want to locate. For the URL value, you can enter the complete forge path, such as https://github.com/jquery/jquery, or a string in the path, such as jquery. |
Note:The search is case-insensitive, so the results will include all components with a matching forge path or path string (whichever criterion you entered in the URL field), no matter the upper or lower case used in the criterion or in the actual component path.
|
•
|
Use the Keyword option to search by component name in the Code Insight Data Library. The name of a component is a unique identifier that can be based on the project, package, or gem name of the component or on another convention such as the component’s author or repository. For the search criterion, enter a single string within the component name. |
Note:The search is case-insensitive and thus filters to all component names containing the Keyword criterion, no matter the upper or lower case used in the criterion or in the actual component name.
For your reference, the following shows the common conventions used for component names in the various forges:
|
•
|
Apache—<PROJECT_NAME>, for example “apache-batik” |
|
•
|
Debian—<PACKAGE_NAME>, for example “0ad” |
|
•
|
Github—<AUTHOR>-<REPOSITORY_NAME>, for example “jquery-jquery-ui” |
|
•
|
GitLab—<AUTHOR/ORGANIZATION>-<REPOSITORY_NAME>, for example: |
|
•
|
“cryptsetup-cryptsetup” (as found in component URL: https://gitlab.com/cryptsetup/cryptsetup) |
|
•
|
“redhat-bison” (as found in component URL: https://gitlab.com/redhat/centos-stream/rpms/bison) |
|
•
|
NuGet Gallery—<PACKAGE_NAME>, for example “newtonsoft.json” |
|
•
|
Pypi—<PACKAGE_NAME>, for example “hash_ring” |
|
•
|
RubyGems—<GEM_NAME>, for example “x-editable-rails” |
|
•
|
Other—<PROJECT_NAME>, for example “openssl” |
|
•
|
If a component you want to examine is not available by a keyword search, select a Forge or URL search. If you are still unable to locate the component, the component might not exist in the Code Insight Data Library. |
|
•
|
Create your inventory item as Work in Progress and name it using the convention <COMPONENT> <VERSION> (<LICENSE>). For example, myComponent 1.2 (MIT). (You can later edit this inventory item to convert it to one of the other inventory types—Component or License.) |