README.md

← Back to plugins index
🗂️ GitHub projects
This plugin displays progress of profile and repository projects.
⚠️ 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) 🔑 public_repo 🔑 read:project read:org (optional) read:user (optional) read:packages (optional) repo (optional)

➡️ Available options

Option	Description
plugin_projects	Enable projects plugin
type: boolean default: no
plugin_projects_limit	Display limit Projects defined by plugin_projects_repositories are not affected by this option
type: number (0 ≤ 𝑥 ≤ 100) default: 4
plugin_projects_repositories	Featured repositories projects Use the following syntax for each project :user/:repo/projects/:project_id ℹ️ GitHub projects (beta) needs to use the same syntax as above and repository must specified repository must be linked to given project.
⏯️ Cannot be preset type: array (comma-separated)
plugin_projects_descriptions	Projects descriptions
type: boolean default: no

🔄 Enabling progress tracking

By default, projects have progress tracking disabled.

To enable it, open the ≡ Menu from the project page and opt-in to Track project progress.

👤 Use personal projects

To create a personal project, select the Projects tab from your profile:

Fill informations and set visibility to public:

📓 Use repositories projects

Repositories projects are created from the Projects tab of a repository.

To use it with this plugin, retrieve the last section of the project URL (it should match the format :user/:repository/projects/:project_id) and add it in the plugin_projects_repositories.

Be sure to tick Track project progress in project settings to display a progress bar.

Example: include a project repository

- uses: lowlighter/metrics@latest
  with:
    plugin_projects: yes
    plugin_projects_repositories: lowlighter/metrics/projects/1

ℹ️ Examples workflows

name: Project from a repository
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.projects.svg
  token: ${{ secrets.METRICS_TOKEN_WITH_SCOPES }}
  base: ""
  plugin_projects: yes
  plugin_projects_repositories: lowlighter/metrics/projects/1
  plugin_projects_descriptions: yes