metrics/source/templates/repository/README.md

← 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