sync-external-contributions

1.2.1 • Public • Published

Sync External Contributions npm

header

Reads all your contributions you've authored on local repositories with git-standup and create a GitHub contribution activity for every commits associated with you.

It does not copy the content of the commit, to respect NDA and privacy it only list all commits SHA you've authored and write it to a file. This is totally safe.

Why?

This script exists because some contracts, projects, or businesses aren't using GitHub as source control. I found it odd that some weeks or months were missing in my GitHub contributions activity as if I wasn't active.

Should external contributions belong there?

To be honest, I'm not sure, but since private contributions can be showed and some are using this to show work activity, why not.

Requirement

Usage

First, you'll need a git repository where the contributions will be synced.

Create it where you want it (e.g. ~/external-contributions), run git init inside and push your initial commit with an empty file named COMMITS.

Create your repository on GitHub and add it as origin, origin will be automatically synced after each runs.

To sync every commits that you've done in ~/some-project into ~/external-contributions:

npx sync-external-contributions --source ~/some-project --destination ~/external-contributions
Options

  --source string[]      Source repositories to fetch commits
  --destination string   Destination repository to sync contributions into
  --days number          Specify the number of days back to include
  --folder-depth         Specify the number of subfolders to look for repos in source
  --dry-run              Will execute script without syncing
  --force                Force push to the destination (implicit with reset)
  --reset                Reset the destination repository
  --silent               Will not prompt
  -h, --help

License

sync-external-contributions is MIT Licensed.

Readme

Keywords

none

Package Sidebar

Install

npm i sync-external-contributions

Weekly Downloads

0

Version

1.2.1

License

MIT

Unpacked Size

9.17 kB

Total Files

6

Last publish

Collaborators

  • charpeni