Cannot generate metrics for vedantmgoyal2009

[vedantmgoyal9]

Hi there,

I have observed that https://metrics.lecoq.io/ cannot generate metrics for me but it can generate for other people.

Why is it so? 😔

Thanks.

[vedantmgoyal9]

@lowlighter I have also tried using a VPN, but still, I'm getting errors.

[lowlighter]

Hi 👋 !

From what I've seen, some of your stats are too high and they result in API timeouts (this can be seen with NaN stats below, and the total contributed repositories does not even display the number)

Your account seems to be able to be generated through the GitHub action (result above) and maybe it'll be possible to fill out gaps for while fixing #951. So you could eventually use it instead.

However I think unfortunately you won't be able to generate these using directly the website. The reason is that to workaround API timeouts, it is required to perform multiples queries instead of a single one, which consume a lots of API requests and resource time, which is why the website actually timeout too

Hope it helps 👍

[vedantmgoyal9]

Actually I was using the website to preview how would my selected configuration would look, and then copy GitHub Adtion code from there.

[lowlighter]

Even without generating the live preview, you should be able to click on the Action code tab and create a new workflow with code displayed.

I think it's the best you can achieve currently 😅

[vedantmgoyal9]

Can you please convert this config to a markdown template and output it directly to README.md at the root of the repository. Actually, I couldn't understand the parameters with the markdown template. Classic template configuration is simple but it's difficult to understand how the markdown template works.

[lowlighter]

The website doesn't provide the templating to use the markdown template anyway, but the documentation for it is located here.

Basically you need to create a TEMPLATE.md first, and you can then use EJS syntax to render variables and sub-graphs.

For example:

<!-- TEMPLATE.md -->

Use fetched data:
<%= plugins.introduction.text %>
<%= plugins.traffic.views.count %>

Embed SVG image
<%- await embed(`unique-id`, {habits:true, habits_charts:true} %>

Include one of markdown supported plugins
<%- await include(`partials/topics.ejs`) %>

# workflow.yml
uses: lowlighter/metrics@latest
with:
  template: markdown
  filename: README.md 
  markdown: https://raw.githubusercontent.com/user/repo/branch/TEMPLATE.md
  token: ${{ secrets.TOKEN }}
  config_output: markdown
  plugin_habits: yes
  plugin_introduction: yes
  plugin_traffic: yes
  plugin_topics: yes

This example.md can give you an idea of what it is supposed to look like

[vedantmgoyal9]

I would rather want to know if there is a setting through which I can directly output SVG to README.md

[lowlighter]

You can just use the link of the rendered SVG in your README.md directly like below:

![Metrics](/github-metrics.svg)

Since it's a link, each time the SVG is updated people will always load the newest render

[vedantmgoyal9]

Is there any way to change the path of SVG? I don't want it in the root of the repository.

[lowlighter]

See filename option for this 🙂

[vedantmgoyal9]

Oh, it's output path. I thought it was just to rename github-metics.svg to .svg. Thanks!🎉