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

Option	Type (format) [default] {allowed values}	Description
plugin_licenses 🧰	boolean [no]	Display licenses informations
plugin_licenses_setup	string []	Command to setup target repository
plugin_licenses_ratio	boolean [no]	Display used licenses ratio
plugin_licenses_legal	boolean [yes]	Display legal informations about used licenses

Legend for option icons:

• 🧰 Must be enabled in settings.json (for web instances)

→ 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'