README.md

📜 Repository licenses

⚠️ This is NOT legal advice, use at your own risk

🔣 On web instances, this plugin is an extra feature and must be enabled globally in settings.json 💣 Note that this plugin allows raw commands injection and is NOT advised to be enabled on them This could result in compromised server!

The licenses plugin lets you display license informations like permissions, limitations and conditions along with additional metrics about dependencies.

Permissions, limitations and conditions Licenses overview

Project must be setup with dependencies using plugin_licenses_setup option (for example, npm ci for a NodeJS project).

Dependencies will be analyzed with github/licensed and compared against GitHub known licenses.

ℹ️ Examples workflows

➡️ Available options for this plugin

- uses: lowlighter/metrics@latest
  with:
    # ... other options
    template: repository
    user: repository-owner
    repo: repository-name
    plugin_licenses: yes
    plugin_licenses_setup: npm ci       # Command to setup target repository
    plugin_licenses_ratio: yes          # Display used licenses ratio
    plugin_licenses_legal: yes          # Display permissions, limitations and conditions