https://github.com/gowee/sync-contrib-calendar-action

💡Light the contribution graph 🟩⬜🟦 by syncing activities from GitLab, LeetCode, MediaWiki, etc., with the help of GitHub Actions
https://github.com/gowee/sync-contrib-calendar-action

contribution-calendar contribution-graph github-actions gitlab leetcode wikipedia

Last synced: 7 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/gowee/sync-contrib-calendar-action
• Owner: Gowee
• License: mit
• Created: 2020-10-15T03:03:09.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2021-06-04T07:56:16.000Z (over 3 years ago)
• Last Synced: 2024-10-27T13:28:34.087Z (10 days ago)
• Topics: contribution-calendar, contribution-graph, github-actions, gitlab, leetcode, wikipedia
• Language: TypeScript
• Homepage:
• Size: 822 KB
• Stars: 0
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build and Test workflow status badge](https://github.com/Gowee/sync-contrib-calendar-action/workflows/Build%20and%20Test/badge.svg)](https://github.com/Gowee/sync-contrib-calendar-action/actions)

[![Relese version badge](https://img.shields.io/github/v/release/Gowee/sync-contrib-calendar-action.svg)](https://github.com/Gowee/intray/releases/)

# Sync Contrib Calendar Action

A :octocat:🔀 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. 

```yml

on: 

  workflow_dispatch

jobs:

  sync:

    runs-on: ubuntu-latest

    steps:

    - uses: actions/checkout@v2

      with:

        fetch-depth: 0

    - uses: gowee/[email protected]

      with:

        source: gitlab

        username: SOME_USERNAME

```

The above workflow is intentionally simplified.

For __a complete workflow__ that runs on schedule automatically, refer to [examples](https://github.com/Gowee/sync-contrib-calendar-action/tree/main/examples).

## Notes

### Security

The action has access to the the [GitHub token](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-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.