name: 📓 Featured repositories
category: github
description: |
  This plugin displays a list of chosen featured repositories.

  Since it is possible to [pin repositories](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/pinning-items-to-your-profile) on GitHub, this plugin is mostly intended for external usage.
notes: |
  > ⚠️ Due to limitations of using SVG images inside `<img>` tags, clicking on a repository card will not redirect to repository page.
examples:
  +featured: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.repositories.svg
  pinned: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.repositories.pinned.svg
index: 14
supports:
  - user
  - organization
scopes:
  - public_access
inputs:

  plugin_repositories:
    description: |
      Enable repositories plugin
    type: boolean
    default: no

  plugin_repositories_featured:
    description: |
      Featured repositories

      Current [`user`](/source/plugins/core/README.md#user) will be used when no owner is specified
    type: array
    format: comma-separated
    default: ""
    example: metrics, lowlighter/metrics
    preset: no

  plugin_repositories_pinned:
    description: |
      Pinned repositories
    type: number
    default: 0
    min: 0
    max: 6

  plugin_repositories_starred:
    description: |
      Featured most starred repositories
    type: number
    default: 0
    min: 0
    max: 100

  plugin_repositories_random:
    description: |
      Featured random repositories
    type: number
    default: 0
    min: 0
    max: 100

  plugin_repositories_order:
    description: |
      Featured repositories display order
    type: array
    values:
      - featured
      - pinned
      - starred
      - random
    default: featured, pinned, starred, random

  plugin_repositories_affiliations:
    description: |
      Repositories affiliations

      - `owner`: owned repositories
      - `collaborator`: repositories with push access
      - `organization_member`: repositories from an organization where user is a member

      Set to `""` to disable and fetch all repositories related to given account.

      This option changes which repositories will be fetched by [`plugin_repositories_starred`](/source/plugins/projects/README.md#plugin_repositories_starred) and [`plugin_repositories_random`](/source/plugins/projects/README.md#plugin_repositories_random) options
    type: array
    format: comma-separated
    default: owner
    values:
      - owner
      - collaborator
      - organization_member