Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 

README.md

🙋 Introduction

The introduction plugin display your account bio or your organization/repository description. It is mostly intended for metrics used outside of GitHub, since these informations are already available on GitHub.

For an user or an organization
For a repository

➡️ Available options

TypeDescription
plugin_introduction

Display account or repository introduction

type: boolean
default: no
plugin_introduction_title

Display introduction section title

type: boolean
default: yes

→ Full specification

ℹ️ Examples workflows

name: Organization introduction
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.introduction.svg
  token: ${{ secrets.METRICS_TOKEN }}
  user: github
  base: header
  plugin_introduction: 'yes'
name: Repository introduction
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.introduction.repository.svg
  token: ${{ secrets.METRICS_TOKEN }}
  template: repository
  repo: metrics
  base: header
  plugin_introduction: 'yes'