⚠️ This plugin requires a personal token with public_repo scope.
The projects plugin displays the progress of your profile projects.
Because of GitHub REST API limitation, provided token requires public_repo
scope to access projects informations.
Note that by default, projects have progress tracking disabled.
To enable it, open the ≡ Menu
and edit the project to opt-in to Track project progress
(it can be a bit confusing since it's actually not in the project settings).
💬 Use repositories projects
It is possible to display projects related to repositories along with personal projects.
To do so, open your repository project and retrieve the last URL endpoint, in the format :user/:repository/projects/:project_id
(for example, lowlighter/metrics/projects/1
) and add it in the plugin_projects_repositories
option. Enable Track project progress
in the project settings to display a progress bar in generated metrics.
➡️ Available options for this plugin
- uses: lowlighter/metrics@latest
with:
# ... other options
plugin_projects: yes
plugin_projects_repositories: lowlighter/metrics/projects/1 # Display #1 project of lowlighter/metrics repository
plugin_projects_limit: 4 # Limit to 4 entries
plugin_projects_descriptions: yes # Display projects descriptions