⚠️ 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).
💬 Create a personal project on GitHub
On your profile, select the Projects tab:
Fill the informations and set visibility to public:
💬 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.
| Option | Type (format) [default] {allowed values} | Description |
|---|---|---|
plugin_projects |
boolean [no] |
Display active projects |
plugin_projects_limit |
number [4] {0 ≤ 𝑥 ≤ 100} |
Maximum number of projects to display |
plugin_projects_repositories |
array (comma-separated,/(?[-a-z0-9]+)/[/]projects//) [] |
List of repository project identifiers to disaplay |
plugin_projects_descriptions |
boolean [no] |
Display projects descriptions |
Legend for option icons:
- 🔐 Value should be stored in repository secrets
- ✨ New feature currently in testing on
master/main
name: Project from a repository
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.projects.svg
token: ${{ secrets.METRICS_BOT_TOKEN }}
base: ''
plugin_projects: 'yes'
plugin_projects_repositories: lowlighter/metrics/projects/1
plugin_projects_descriptions: 'yes'