mirrors/PowerShell
0
0
Fork 0
mirror of https://github.com/PowerShell/PowerShell.git synced 2024-11-26 19:34:22 +08:00
Code Issues Packages Projects Releases Wiki Activity
master
PowerShell/tools/clearlyDefined
History
Travis Plunk 232b6b1273
Verify that packages have license data (#19543)
2023-04-21 11:50:49 -07:00
..
src/ClearlyDefined Add tool to trigger license information gathering for NuGet modules (#18827) 2023-01-31 12:58:15 -08:00
ClearlyDefined.ps1 Verify that packages have license data (#19543) 2023-04-21 11:50:49 -07:00
readme.md Add tool to trigger license information gathering for NuGet modules (#18827) 2023-01-31 12:58:15 -08:00

readme.md

ClearlyDefined

Purpose

This tool is intended to test if all the license data in ClearlyDefined is present to generate the PowerShell license. If the data is not present, it can request that ClearlyDefined gather (called Harvest in their terminology) the data.

Use

Testing

Run ./ClearlyDefined.ps1 -test.

If there is any missing data, the script should write verbose messages about the missing data and throw. If there is no missing data, the script should not throw.

Harvesting

Run ./ClearlyDefined.ps1 -Harvest. The script will trigger the harvest and output the result from ClearlyDefined. Give ClearlyDefined 24 hours to harvest the data. You can use the -Test switch without the -Harvest switch to test if Harvesting is done.

Caching

If you run in the same PowerShell session, the script will be faster due to caching.

The module will cache any results from ClearlyDefined that indicate the package is Harvested for 60 minutes. No caching is done for packages that are not yet harvested. To clear the cache, run with the -ForceModuleReload switch.