Gowee / sync-contrib-calendar-action

💡Light the contribution graph 🟩⬜🟦 by syncing activities from GitLab, LeetCode, MediaWiki, etc., with the help of GitHub Actions

Sync Contrib Calendar Action

A 🔀 GitHub action that helps grabs activities from GitLab, LeetCode, etc., to populate the contribution calendar graph on GitHub.

What the action actually does?

For every contribution/activity on other platforms, it accordingly creates an emtpy commit at that time point to light (or deepen the color of) a little square on the contribution graph.

Setup

Create a new empty repository and activate the action by applying the following MVP workflow (e.g. into .github/workflows/sync-gitlab.yml). After that, manually trigger the workflow in the Action tab.

on: 
  workflow_dispatch

jobs:
  sync:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
      with:
        fetch-depth: 0
    - uses: gowee/sync-contrib-calendar-action@0.1-alpha
      with:
        source: gitlab
        username: SOME_USERNAME

The above workflow is intentionally simplified.

For a complete workflow that runs on schedule automatically, refer to examples.

Notes

Security

The action has access to the the GitHub token provided automatically by the GitHub Action runtime, so that to push commits without requiring manual configuration. Outgoing requests are made only to fetch actitivies from data sources such as GitLab. But be reminded that the software is provided as-is, with NO WARRANTY.

Caveat

The action is not well tested, which, in the worst cases, may result in tons of repeated commits unexpectedly. It is strongly recommended to create a new repository for the action to work separately.