README.md

November 14, 2023 ยท View on GitHub

โ† Back to templates index

๐Ÿ“˜ Repository template

A template mimicking GitHub visual identity and specially crafted for repositories.

Supported features
โ†’ Full specification		 ๐Ÿ“ฐ ๐Ÿช™ ๐Ÿ“ธ ๐Ÿ’น ๐Ÿ… ๐ŸŽŸ๏ธ ๐Ÿ™‹ ๐Ÿˆท๏ธ ๐Ÿ“œ ๐Ÿ‘จโ€๐Ÿ’ป โฑ๏ธ ๐Ÿง‘โ€๐Ÿคโ€๐Ÿง‘ โœ’๏ธ ๐Ÿ—‚๏ธ ๐Ÿ—ผ ๐Ÿ’• โœจ ๐Ÿงฎ
๐Ÿ““ Repositories
*๏ธโƒฃ SVG *๏ธโƒฃ PNG *๏ธโƒฃ JPEG #๏ธโƒฃ JSON

๐ŸŽŽ Using a repository template

To use a repository template, a repo handle must be provided.

If the token owner is not the repository owner, then the user option must be set to the repository owner (whether it is an user or organization account).

Example: render lowlighter/metrics repository

- uses: lowlighter/metrics@latest
  with:
    template: repository
    user: lowlighter
    repo: metrics

โ„น๏ธ Examples workflows

name: Example
uses: lowlighter/metrics@latest
with:
  template: repository
  filename: metrics.repository.svg
  token: ${{ secrets.METRICS_TOKEN_WITH_SCOPES }}
  user: lowlighter
  repo: metrics
  plugin_lines: yes
  plugin_followup: yes
  plugin_projects: yes
  plugin_projects_repositories: lowlighter/metrics/projects/1