Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/b1f6c1c4/hub-sync
Sync your github forks without git.
https://github.com/b1f6c1c4/hub-sync
api git github hub-sync sync tools
Last synced: about 2 months ago
JSON representation
Sync your github forks without git.
- Host: GitHub
- URL: https://github.com/b1f6c1c4/hub-sync
- Owner: b1f6c1c4
- License: mit
- Created: 2018-03-28T03:41:16.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-05-01T20:43:49.000Z (5 months ago)
- Last Synced: 2024-07-05T22:51:41.401Z (3 months ago)
- Topics: api, git, github, hub-sync, sync, tools
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/@b1f6c1c4/hub-sync
- Size: 57.6 KB
- Stars: 24
- Watchers: 4
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# @b1f6c1c4/hub-sync
[](https://www.npmjs.com/package/@b1f6c1c4/hub-sync)
[](https://www.npmjs.com/package/@b1f6c1c4/hub-sync)
[](https://github.com/b1f6c1c4/hub-sync)
[](https://github.com/b1f6c1c4/hub-sync)
[](https://github.com/b1f6c1c4/hub-sync/blob/master/LICENSE.md)
> Sync your github forks without git in O(1) time, space, and network BW.
## Basic usage
1. Install the package with *npm* ([nodejs package manager](https://nodejs.org/)).
```bash
npm i -g @b1f6c1c4/hub-sync
```
1. Update your fork *instantly*.
For the first time you run this, you will be asked to generate a [GitHub Personal Access Token](https://github.com/settings/tokens).
Follow the instructions carefully and **keep your token CONFIDENTIAL.**
```bash
hub-sync
```
## Advanced usage
1. Update a certain branch:
```bash
hub-sync /
```
1. Update from another user's fork:
```bash
hub-sync
```
1. Update from another user's fork, but with a different name:
```bash
hub-sync /
```
1. Update from another user's fork, but with a different name and a different branch:
```bash
hub-sync / //
```
1. Point a branch of your repo to a specific SHA-1: (rarely used)
```bash
hub-sync /
```
1. Create a new branch:
```bash
hub-sync -c
```
1. Update even if not fast-forward: **(EXTREMELY DANGEROUS)**
```bash
hub-sync -f
```
1. Delete a branch: **(EXTREMELY EXTREMELY DANGEROUS)**
```bash
hub-sync --delete
```
1. See `hub-sync --help` for the complete usage documentation.
Notice: There is **NO SAFETY NET** at all for `-f|--force` and `-d|--delete`.
**YOU MAY LOSE ALL YOUR WORK ON THAT BRANCH IMMEDIATELY** if not used properly.
Neither Github nor the author of `hub-sync` will be responsible for your loss.
USE AT YOUR OWN RISK. REFER TO THE LICENSE FOR LEGAL ISSUE.
## Technical details
To keep your github fork up-to-date, the [old-fashioned way](https://help.github.com/articles/syncing-a-fork/) is:
```sh
git clone https://github.com//
cd
git remote add upstream https://github.com//
git fetch upstream
git push origin upstream/master
cd ..
rm -rf .git
```
However, this is totally pointless since you actually download all the data from github.com and upload all the way back. (I know git may be smart enough to upload only what github.com already has, but you have to download everything first.)
This approach takes **as bad as O(n) time, O(n) space, O(n) network bandwidth**.
So the solution is to call Github API directly:
```sh
# Assuming you are using HTTPie:
http GET https://api.github.com/repos///git/refs/heads/master
# Find object.sha, and
http PATCH https://api.github.com/repos///git/refs/heads/master "Authorization ..." sha=...
# If branch non-exist, use the following instead
http POST https://api.github.com/repos///git/refs "Authorization ..." sha=...
```
Now `hub-sync` does this for you, **as smooth as O(1)**:
```sh
# This can be ran everywhere; it works without git.
hub-sync [-f|-c|-d] // //
```
### Wanna take more control over the process, but not to clone everything?
You will need [`git-get`](https://github.com/b1f6c1c4/git-get) and [`git-fancy-push`](https://github.com/b1f6c1c4/git-fancy-push).
The latter one resolved the long-standing "shallow update not allowed" problem.
```bash
git get -g /
git remote add upstream ...
git fancy-push upstream origin/master:master
```
## License
MIT