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:

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:

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"

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.

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 Click New token with

Step 4: Add your Hugging Face token in Github

Go to settings Then find the left menu, Security and there find Actions click on that and then Click New repository secret and paste it then

Step 4: Set up a GitHub Action to push your main branch to Spaces

Go to Actions and click setup workflow yourself, for exmaple

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

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:[email protected]/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:

run: git push https://ruslanmv:[email protected]/spaces/ruslanmv/Milvus-Client-Embedding main

and then commit

run: git push https://ruslanmv:[email protected]/spaces/ruslanmv/Milvus-Client-Embedding main

If you got errors

run: git push https://ruslanmv:[email protected]/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:

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/[email protected]
        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.

For more custom syncs on Hugging Face visit the original source from here.

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.