chatwoot-contributors's Introduction

Contributors Page Template

This project iterates through your entire Github organization and builds a contributors page. Much like https://contributors.chatwoot.com. You can set up a contributors page for your organization quickly.

⭐ How it works

GitHub Actions is used to pull the commits and create the contributor database.

Every 6 hours, a workflow fetches the latest commits from all the repositories and update the contributor/commit data.
This information is committed back to the repository.
A leaderboard based on the commit history is created automatically.

Publishing the page is automated using Github Actions.

Every time a commit is done on the master branch, the gh-pages workflow would run and the branch gh-pages would be updated.

👩‍💻 How to set up your own contributors page?

Create a repository from this template.
Update the contributors.config.js file in the repository as follows.

Key	Description
basePath	If you are hosting the page on Github pages, then you would need to configure this to the name of your repository. eg: '/contributors-page'
projectName	This can be your brand name, project name etc
siteMetadata.title	This title field is used as the title in the generated webpage
pageTitle	Share the title to be shown on the page. eg: 'We thank all our contributors'
pageDescription	Along with the title, if you want to show gratitude to the community you can use the description. eg: Chatwoot would not have been what it is today without the help of our amazing contributors.
githubLink	Link to your Github Repo / Organization
contributingGuide	Link to your documentation on how some one can contribute to the page
sponsorsLink	If you have Github sponsor/other sponsor page, you can link here
github.org	Use the organization name you want to include in the contributors page
github.repoNames	List the repositories you want to include while creating the contributors page. eg: [chatwoot,chatwoot-mobile-app,charts,docs]

chatwoot-contributors's People

Contributors

Stargazers

Watchers

chatwoot-contributors's Issues

Brand Assets

gg

gh action fails to pull commit history

GH action is now failing to pull commit history. Please find the error from gh action.

$ node index.js
file:///home/runner/work/chatwoot-contributors/chatwoot-contributors/scripts/index.js:9
const contributorsConfig = require('../contributors.config');
                           ^

ReferenceError: require is not defined in ES module scope, you can use import instead
This file is being treated as an ES module because it has a '.js' file extension and '/home/runner/work/chatwoot-contributors/chatwoot-contributors/scripts/package.json' contains "type": "module". To treat it as a CommonJS script, rename it to use the '.cjs' file extension.
    at file:///home/runner/work/chatwoot-contributors/chatwoot-contributors/scripts/index.js:9:28
    at ModuleJob.run (node:internal/modules/esm/module_job:198:25)
    at async Promise.all (index 0)
    at async ESMLoader.import (node:internal/modules/esm/loader:385:24)
    at async loadESM (node:internal/process/esm_loader:88:5)
    at async handleMainPromise (node:internal/modules/run_main:61:12)
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
Error: Process completed with exit code 1.

ref: https://github.com/chatwoot/chatwoot-contributors/runs/6364765755?check_suite_focus=true