sudacode/metrics
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

The great refactor (#82)

Browse Source
This commit is contained in:
Simon Lecoq
2021-01-30 12:31:09 +01:00
committed by GitHub
parent f8c6d19a4e
commit 682e43e10b
158 changed files with 6738 additions and 5022 deletions
Download Patch File Download Diff File Expand all files Collapse all files

55
source/plugins/projects/README.md Normal file
View File

@@ -0,0 +1,55 @@
### 🗂️ Projects <sup>🚧 <code>plugin_projects_descriptions</code> on <code>@master</code></sup>
⚠️ This plugin requires a personal token with public_repo scope.
The *projects* plugin displays the progress of your profile projects.
<table>
<td align="center">
<img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.projects.svg">
<img width="900" height="1" alt="">
</td>
</table>
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).
![Enable "Track project progress"](/.github/readme/imgs/plugin_projects_track_progress.png)
<details>
<summary>💬 Create a personal project on GitHub</summary>
On your profile, select the `Projects` tab:
![Create a new project](/.github/readme/imgs/plugin_projects_create.png)
Fill the informations and set visibility to *public*:
![Configure project](/.github/readme/imgs/plugin_projects_setup.png)
</details>
<details>
<summary>💬 Use repositories projects</summary>
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.
![Add a repository project](/.github/readme/imgs/plugin_projects_repositories.png)
</details>
#### ℹ️ Examples workflows
[➡️ Available options for this plugin](metadata.yml)
```yaml
- 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
```