metrics/source/plugins/licenses/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.

➡️ Available options

Type	Description
plugin_licenses	Display licenses informations
🌐 Web instances must configure settings.json type: boolean default: no
plugin_licenses_setup	Command to setup target repository
type: string
plugin_licenses_ratio	Display used licenses ratio
type: boolean default: no
plugin_licenses_legal	Display legal informations about used licenses
type: boolean default: yes

→ Full specification

ℹ️ Examples workflows

name: Licenses and permissions
with:
  filename: metrics.plugin.licenses.svg
  token: ${{ secrets.METRICS_TOKEN }}
  base: ''
  template: repository
  repo: metrics
  plugin_licenses: 'yes'
  plugin_licenses_setup: npm ci

name: Licenses with open-source ratio graphs
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.licenses.ratio.svg
  token: ${{ secrets.METRICS_TOKEN }}
  base: ''
  template: repository
  repo: metrics
  plugin_licenses: 'yes'
  plugin_licenses_setup: npm ci
  plugin_licenses_legal: 'no'
  plugin_licenses_ratio: 'yes'