← Back to plugins index

📆 Calendar

This plugin displays your commit calendar across several years

Supported features
→ Full specification		 📗 Classic template
👤 Users
🔑 (scopeless) read:org (optional) read:user (optional) read:packages (optional) repo (optional)
Current year
Full history
## ➡ī¸ Available options
OptionDescription

plugin_calendar

Enable calendar plugin
type: boolean
default: no

plugin_calendar_limit

Years to display

This option has different behaviours depending on its value:

  • n > 0 will display the last n years, relative to current year
  • n == 0 will display all years starting from GitHub account registration date
  • n < 0 will display all years plus n additional years, relative to GitHub account registration date
    • Use this when there are commits pushed before GitHub registration
type: number
zero behaviour: disable
default: 1
## ℹī¸ Examples workflows ```yaml name: Current year calendar uses: lowlighter/metrics@latest with: filename: metrics.plugin.calendar.svg token: ${{ secrets.METRICS_TOKEN }} base: "" plugin_calendar: yes ``` ```yaml name: Full history calendar uses: lowlighter/metrics@latest with: filename: metrics.plugin.calendar.full.svg token: ${{ secrets.METRICS_TOKEN }} base: "" plugin_calendar: yes plugin_calendar_limit: 0 ```