| Option | Description |
plugin_projects
|
Enable projects plugin
![]() |
type: boolean
default: no
|
plugin_projects_limit
|
Display limit
Note that plugin_projects_repositories is not affected by this option
![]() |
type: number
(0 â¤
đĨ
⤠100)
default: 4
|
plugin_projects_repositories
|
List of repositories projects
Use the following syntax for each project :user/:repo/projects/:project_id
![]() |
â¯ī¸ Cannot be preset
type: array
(comma-separated)
|
plugin_projects_descriptions
|
Toggle projects descriptions display
![]() |
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*
```yml
- uses: lowlighter/metrics@latest
with:
plugin_projects: yes
plugin_projects_repositories: lowlighter/metrics/projects/1
```
## âšī¸ Examples workflows
```yaml
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
```
