Skip to main content

License

The following rule type is available for checking for license files in a repository.

stacklok/license - Verifies that there's a license file of a given type present in the repository​

Verifies that there's a license file of a given type present in the repository.

The license rule type ensures that a license file is present in the repository and its license type complies with the configured license type in your profile.

For more information, see https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository

Entity​

  • repository

Type​

  • stacklok/license

Rule Parameters​

The stacklok/license rule supports the following parameters:

  • None

Rule Definition Options​

The stacklok/license rule has the following options:

  • license_filename (string) - The license filename to look for.
    • Example: LICENSE, LICENSE.txt, LICENSE.md, etc.
  • license_type (string) - The license type to look for in license_filename.
    • Example: MIT, Apache, etc. See SPDX License List for a list of license types. Leave "" to only check for the presence of the file.