Add new Discussions plugin (#430) [skip ci]

This commit is contained in:
Simon Lecoq
2021-07-30 23:05:12 +02:00
committed by GitHub
parent a32069297a
commit 88f9e1a41f
11 changed files with 213 additions and 0 deletions

View File

@@ -0,0 +1,21 @@
### 💬 Discussions
The *discussions* plugin displays your GitHub discussions metrics.
<table>
<td align="center">
<img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.discussions.svg">
<img width="900" height="1" alt="">
</td>
</table>
#### Examples workflows
[➡️ Available options for this plugin](metadata.yml)
```yaml
- uses: lowlighter/metrics@latest
with:
# ... other options
plugin_discussions: yes
```

View File

@@ -0,0 +1,46 @@
//Setup
export default async function({login, q, imports, graphql, queries, data, account}, {enabled = false} = {}) {
//Plugin execution
try {
//Check if plugin is enabled and requirements are met
if ((!enabled)||(!q.discussions))
return null
//Load inputs
imports.metadata.plugins.discussions.inputs({data, account, q})
const discussions = {categories:{}}
//Fetch general statistics
const stats = Object.fromEntries(Object.entries((await graphql(queries.discussions.statistics({login}))).user).map(([key, value]) => [key, value.totalCount]))
Object.assign(discussions, stats)
//Load started discussions
{
const fetched = []
const categories = {}
let cursor = null
let pushed = 0
do {
console.debug(`metrics/compute/${login}/discussions > retrieving discussions after ${cursor}`)
const {user:{repositoryDiscussions:{edges = [], nodes = []} = {}}} = await graphql(queries.discussions.categories({login, after:cursor ? `after: "${cursor}"` : ""}))
cursor = edges?.[edges?.length - 1]?.cursor
fetched.push(...nodes)
pushed = nodes.length
console.debug(`metrics/compute/${login}/discussions > retrieved ${pushed} discussions after ${cursor}`)
} while ((pushed) && (cursor))
//Compute favorite category
for (const category of [...fetched.map(({category:{emoji, name}}) => `${imports.emoji.get(emoji)} ${name}`)])
categories[category] = (categories[category] ?? 0) + 1
discussions.categories.stats = categories
discussions.categories.favorite = Object.entries(categories).sort((a, b) => b[1] - a[1]).map(([name]) => name).shift() ?? null
}
//Results
return discussions
}
//Handle errors
catch (error) {
throw {error:{message:"An error occured", instance:error}}
}
}

View File

@@ -0,0 +1,12 @@
name: "💬 Discussions"
cost: 1 GraphQL request + 1 GraphQL request per 100 discussions started
category: github
supports:
- user
inputs:
# Enable or disable plugin
plugin_discussions:
description: GitHub discussions metrics
type: boolean
default: no

View File

@@ -0,0 +1,15 @@
query DiscussionsCategories {
user(login: "$login") {
repositoryDiscussions($after first: 100, orderBy: {field: CREATED_AT, direction: DESC}) {
edges {
cursor
}
nodes {
category {
emoji
name
}
}
}
}
}

View File

@@ -0,0 +1,13 @@
query DiscussionsStatistics {
user(login: "$login") {
started: repositoryDiscussions {
totalCount
}
comments: repositoryDiscussionComments {
totalCount
}
answers: repositoryDiscussionComments(onlyAnswers: true) {
totalCount
}
}
}

View File

@@ -0,0 +1,5 @@
- name: Discussions plugin (default)
uses: lowlighter/metrics@latest
with:
token: MOCKED_TOKEN
plugin_discussions: yes