How-to-Sync-Hugging-Face-Spaces-with-a-GitHub-Repository

KO | EN

gitlite — search

#python #hacktoberfest #react #ai #llm #go #android #deep-learning #linux #nodejs #macos #vue #mcp #open-source

How-to-Sync-Hugging-Face-Spaces-with-a-GitHub-Repository

(★ 79)

How to Sync Hugging Face Spaces with a GitHub Repository

How-to-Sync-Hugging-Face-Spaces-with-a-GitHub-Repository Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# How to Sync Hugging Face Spaces with a GitHub Repository

## Introduction:
In this blog, we'll walk you through the process of syncing a Hugging Face Space with a GitHub repository.

As an example, we'll sync the following GitHub repository: 
```
https://github.com/ruslanmv/Milvus-Client-Embedding 
```

into a Hugging Face Space:

```
https://huggingface.co/spaces/ruslanmv/Milvus-Client-Embedding.
```

## Prerequisites:
- A GitHub repository
- A Hugging Face Space
- Hugging Face API token (found under API Tokens on your Hugging Face profile)

## Step 1: Set up your GitHub repository and Spaces app together

First, add your Spaces app as an additional remote to your existing Git repository by running the following command in your terminal:

```bash
git remote add space https://huggingface.co/spaces/HF_USERNAME/SPACE_NAME
```

Replace `HF_USERNAME` with your Hugging Face username and `SPACE_NAME` with your Space name.

For our example, let us enter to your folder where you have your GitHub Repository

```
git clone https://github.com/ruslanmv/Milvus-Client-Embedding 
cd Milvus-Client-Embedding 
```
Then by using  `HF_USERNAME=ruslanmv` and `SPACE_NAME=Milvus-Client-Embedding`, the command would be:

```bash
git remote add space https://huggingface.co/spaces/ruslanmv/Milvus-Client-Embedding
```

## Step 2: Force push to sync everything for the first time

Run the following command in your terminal to sync your GitHub repository and Hugging Face Space:

```
git add .
git commit -m "Initial commit"
```

```bash
git push --force space main
```
If  you got the error message `src refspec main does not match any` indicates that the `main` branch doesn't exist in the Hugging Face Space.

```bash
git push --force space master:main
```
* `git push --force space master:main` instead of `git push --force space main`
	+ `master` is the default branch in your GitHub repository.
	+ `main` is the branch you want to create in your Hugging Face Space.
	+ The `:` notation specifies the source and destination branches.

By using `master:main`, you're telling Git to push the `master` branch from your local repository to the `main` branch in the Hugging Face Space.

If you've already created a branch in your Hugging Face Space, make sure to replace `main` with the actual branch name.
## Step 3: Create Token in Hugging Face and copy the token
First go to thee hf tokens [here](https://huggingface.co/settings/tokens)
Click New  token with 
![](https://raw.githubusercontent.com/ruslanmv/How-to-Sync-Hugging-Face-Spaces-with-a-GitHub-Repository/master/assets/2024-02-15-12-32-56.png)

## Step 4: Add your Hugging Face token in Github
Go to settings
![](https://raw.githubusercontent.com/ruslanmv/How-to-Sync-Hugging-Face-Spaces-with-a-GitHub-Repository/master/assets/2024-02-15-12-29-19.png)
Then find the left menu, Security and there find Actions click on that and then Click `New repository secret`
![](https://raw.githubusercontent.com/ruslanmv/How-to-Sync-Hugging-Face-Spaces-with-a-GitHub-Repository/master/assets/2024-02-15-12-31-57.png)
and paste it 
![](https://raw.githubusercontent.com/ruslanmv/How-to-Sync-Hugging-Face-Spaces-with-a-GitHub-Repository/master/assets/2024-02-15-12-35-08.png)
then
![](https://raw.githubusercontent.com/ruslanmv/How-to-Sync-Hugging-Face-Spaces-with-a-GitHub-Repository/master/assets/2024-02-15-12-35-44.png)

## Step 4: Set up a GitHub Action to push your main branch to Spaces
Go to Actions and click setup workflow yourself, for exmaple
![](https://raw.githubusercontent.com/ruslanmv/How-to-Sync-Hugging-Face-Spaces-with-a-GitHub-Repository/master/assets/2024-02-15-12-26-20.png)

Create a new GitHub Action in your repository with the following content:

```yaml
name: Sync to Hugging Face hub
on:
  push:
    branches: [main]
  # to run this workflow manually from the Actions tab
  workflow_dispatch:

jobs:
  sync-to-hub:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
        with:
          fetch-depth: 0
          lfs: true
      - name: Push to hub
        env:
          HF_TOKEN: ${{ secrets.HF_TOKEN }}
        run: git push https://HF_USERNAME:$HF_TOKEN@huggingface.co/spaces/HF_USERNAME/SPACE_NAME main
```

Replace `HF_USERNAME` with your username and `SPACE_NAME` with your Space name. Then, create a GitHub secret with your `HF_TOKEN`. You can find your Hugging Face API token under API Tokens on your Hugging Face profile.

For our example with `HF_USERNAME=ruslanmv` and `SPACE_NAME=Milvus-Client-Embedding`, the `run` line in the GitHub Action would be:

```yaml
run: git push https://ruslanmv:$HF_TOKEN@huggingface.co/spaces/ruslanmv/Milvus-Client-Embedding main
```

![](https://raw.githubusercontent.com/ruslanmv/How-to-Sync-Hugging-Face-Spaces-with-a-GitHub-Repository/master/assets/2024-02-15-12-38-21.png)

and then commit

run: git push https://ruslanmv:$HF_TOKEN@huggingface.co/spaces/ruslanmv/Milvus-Client-Embedding main

![](https://raw.githubusercontent.com/ruslanmv/How-to-Sync-Hugging-Face-Spaces-with-a-GitHub-Repository/master/assets/2024-02-15-12-40-13.png)
If you got errors

```yaml
run: git push https://ruslanmv:$HF_TOKEN@huggingface.co/spaces/ruslanmv/Milvus-Client-Embedding master:main
```

## Step 4: Create an Action
Create an Action that automatically checks the file size of any new pull request
Add another GitHub Action to your repository with the following content:

```yaml
name: Check file size
on:
  pull_request:
    branches: [main]

# to run this workflow manually from the Actions tab
  workflow_dispatch:

jobs:
  sync-to-hub:
    runs-on: ubuntu-latest
    steps:
      - name: Check large files
        uses: ActionsDesk/lfs-warning@v2.0
        with:
          filesizelimit: 10485760 # this is 10MB
```

This action will automatically check the file size of any new pull request and ensure that no files larger than 10MB are added to the repository.
![](https://raw.githubusercontent.com/ruslanmv/How-to-Sync-Hugging-Face-Spaces-with-a-GitHub-Repository/master/assets/2024-02-15-12-43-51.png)

For more custom syncs on Hugging Face visit the original source from [here](https://huggingface.co/docs/hub/en/spaces-github-actions).

### GitHub is the single source of truth

If GitHub is your canonical source, keep the Space perfectly in sync by **forcing** the Space’s `main` to match your repo’s current `HEAD`—manually with `git push --force "$REMOTE_URL" HEAD:main`, or automatically using the force-by-default CI workflow in your repo at [.github/workflows/sync-to-hf-space.yml](https://github.com/ruslanmv/How-to-Sync-Hugging-Face-Spaces-with-a-GitHub-Repository/blob/master/.github/workflows/sync-to-hf-space.yml). Add one GitHub **Secret** (`HF_TOKEN`, your HF write token) and two **Repository Variables** (`HF_USERNAME`, `SPACE_NAME`). From then on, every push to `main` (or `master`) will overwrite the Space’s `main`, eliminating drift from edits made directly in the Space—simple, predictable, and production-friendly. Just note this is **destructive to remote edits**, so only use it when GitHub is the single source of truth.

## Conclusion:

By following these steps, you've successfully synced your GitHub repository with your Hugging Face Space. Now, any changes you push to your GitHub repository will automatically be reflected in your Hugging Face Space. In our specific example, changes pushed to the `ruslanmv/Milvus-Client-Embedding` GitHub repository will be synced with the `ruslanmv/Milvus-Client-Embedding` Hugging Face Space.

How-to-Sync-Hugging-Face-Spaces-with-a-GitHub-Repository

How-to-Sync-Hugging-Face-Spaces-with-a-GitHub-Repository Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

How-to-Sync-Hugging-Face-Spaces-with-a-GitHub-Repository

How-to-Sync-Hugging-Face-Spaces-with-a-GitHub-Repository Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README