metrics/source/plugins/lines/README.md

← Back to plugins index
👨‍💻 Lines of code changed
This plugin displays the number of lines of code added and removed across repositories.
⚠️ Disclaimer	This plugin is not affiliated, associated, authorized, endorsed by, or in any way officially connected with GitHub. All product and company names are trademarks™ or registered® trademarks of their respective holders.
Supported features → Full specification	📗 Classic template 📘 Repository template 📙 Terminal template
	👤 Users 👥 Organizations 📓 Repositories
	🔑 (scopeless) read:org (optional) read:user (optional) read:packages (optional) repo (optional)
Repositories and diff history Compact display in base plugin

➡️ Available options

Option	Description
plugin_lines	Enable lines plugin
type: boolean default: no
plugin_lines_skipped	Skipped repositories
⏩ Inherits repositories_skipped type: array (newline-separated)
plugin_lines_sections	Displayed sections base will display the total lines added and removed in base.repositories section repositories will display repositories with the most lines added and removed history will display a graph displaying lines added and removed over time ℹ️ base requires at least base: repositories to be set
type: array (comma-separated) default: base allowed values: base repositories history
plugin_lines_repositories_limit	Display limit
type: number (0 ≤ 𝑥) default: 4
plugin_lines_history_limit	Years to display Will display the last n years, relative to current year
type: number zero behaviour: disable default: 1
plugin_lines_delay	Delay before performing a second query When non-zero, will perform a second query after specified delay (in seconds). The GitHub endpoint used may return inaccurate results on first query (these values seems to be cached on the fly), after returning correct results upon performing another query. Using this option may mitigate the occurrence of weird values.
✨ On master/main type: number (0 ≤ 𝑥) zero behaviour: disable default: 0

ℹ️ Examples workflows

name: Compact display in base plugin
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.lines.svg
  token: ${{ secrets.METRICS_TOKEN }}
  base: repositories
  plugin_lines: yes

name: Repositories and diff history
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.lines.history.svg
  token: ${{ secrets.METRICS_TOKEN }}
  base: ""
  plugin_lines: yes
  plugin_lines_sections: repositories, history
  plugin_lines_repositories_limit: 2
  plugin_lines_history_limit: 1
  repositories_skipped: |
    @use.patterns
    */*
    +lowlighter/metrics