Skip to content

Latest commit

 

History

History
87 lines (81 loc) · 3.07 KB

README.md

File metadata and controls

87 lines (81 loc) · 3.07 KB
← Back to plugins index

🙋 Introduction

This plugin displays account bio or organization/repository description.

Since account bio is already displayed on account profile, this plugin is mostly intended for external usage.

⚠️ 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
👤 Users 👥 Organizations 📓 Repositories
🔑 (scopeless) read:org (optional) read:user (optional) read:packages (optional) repo (optional)
For a user or an organization
For a repository

➡️ Available options

OptionDescription

plugin_introduction

Enable introduction plugin

type: boolean
default: no

plugin_introduction_title

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