Skip to content

Latest commit

 

History

History
83 lines (77 loc) · 2.68 KB

README.md

File metadata and controls

83 lines (77 loc) · 2.68 KB

🙋 Introduction

This plugin displays account bio or organization/repository description.

It is mostly intended for images that will be used outside of GitHub, since these informations are already displayed on GitHub.

Supported features
→ Full specification
📗 Classic template 📘 Repository template
👤 Users 👥 Organizations 📓 Repositories
🔑 (scopeless) read:org (optional) read:user (optional) repo (optional)
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

ℹ️ 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