How to get all-contributers github app to render table of contributors and badge?

Viewed 27

I'm using https://github.com/all-contributors/all-contributors, and I've gone through every detail I can on their documentation https://allcontributors.org/ as well. And been trying different things for the past 2 hours but I can't get this app to render the table of contributors. Their documentation is incredibly poor.

I have:

{
  "files": [
    "readme.md",
    "docs/authors.md",
    "docs/contributors.md"
  ],
  "imageSize": 100,
  "contributorsPerLine": 7,
  "contributorsSortAlphabetically": false,
  "badgeTemplate": "[![All Contributors](https://img.shields.io/badge/all_contributors-<%= contributors.length %>-pink.svg)](#contributors)",
  "contributorTemplate": "<a href=\"<%= contributor.profile %>\"><img src=\"<%= contributor.avatar_url %>\" width=\"<%= options.imageSize %>px;\" alt=\"\"/><br /><sub><b><%= contributor.name %></b></sub></a>",
  "types": {
    "contributor": {
      "symbol": "❤️",
      "description": "Contributor ❤️",
      "link": "[<%= symbol %>](<%= url %> \"<%= description %>\"),"
    }
  },
  "skipCi": true,
  "contributors": [],
  "projectName": ".github",
  "projectOwner": "owner",
  "repoType": "github",
  "repoHost": "https://github.com"
}

I then use @all-contributors add @somename to code and it does correctly add it to the .all-contributersrc file, however it doesn't render the table in the readme.md.

I've also tried to hardcode the list in readme using:

<!-- ALL-CONTRIBUTORS-LIST:START -->

<!-- ALL-CONTRIBUTORS-LIST:END -->

But no luck, nothing happens.

I also can not get the badge working. I can hardcode the badge and display "a" badge, but it never uses the above template badge with dynamic contributor length. So it's also not injecting the badge or using that template badge at all.

How can I get this bot to correctly show the badge and show the contributor list and generate the table in readme.md?

Note: I'm not interested in using node or running some generate command manually locally, then it defeats the point of using that app at all, then I can just as well do it myself. According to their documentation it should be generating the table automatically on first contributor, but it does not.

Also when I go to https://raw.githubusercontent.com/all-contributors/all-contributors/master/README.md in raw view, I can see:

enter image description here

Which tells me it has to be generating that table somehow, but it doesn't seem to work.

1 Answers
Related