https://github.com/rahulbhoyar1995/hf-spaces-with-github-actions-tutorial
Learn to automate the creation of highly functional spaces using GitHub Actions. This tutorial repository guides you through setting up automated workflows for managing spaces efficiently within your projects.
https://github.com/rahulbhoyar1995/hf-spaces-with-github-actions-tutorial
github-token guthubactions huggingface
Last synced: 3 months ago
JSON representation
Learn to automate the creation of highly functional spaces using GitHub Actions. This tutorial repository guides you through setting up automated workflows for managing spaces efficiently within your projects.
- Host: GitHub
- URL: https://github.com/rahulbhoyar1995/hf-spaces-with-github-actions-tutorial
- Owner: rahulbhoyar1995
- License: mit
- Created: 2024-04-14T09:47:01.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-28T13:47:02.000Z (about 1 year ago)
- Last Synced: 2025-01-15T23:25:31.115Z (5 months ago)
- Topics: github-token, guthubactions, huggingface
- Homepage:
- Size: 16.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# HuggingSpace Repos with Github Actions Tutorial
#### Author : Rahul Bhoyar
In this tutorial, you'll learn how to use GitHub Actions to keep your application synchronized with your GitHub repository. When using Spaces, remember that files larger than 10MB require Git-LFS. If you choose not to use Git-LFS, you'll need to review your files and history. You can use tools like BFG Repo-Cleaner to remove large files from your history, ensuring smooth synchronization.
#### Step 1: Create a repo on Github
To initiate the process, navigate to Github and create a new repository for your codebase. Ensure you provide an informative name and description for your repository. Store your code to this repository.
(Note : If you have larger files, please refer this tutorial before you proceed : https://huggingface.co/docs/hub/repositories-getting-started#terminal)
#### Step 2: Set up Repository and Spaces App
Now, we will link the GitHub repository with your Spaces app. Add your Spaces app as an additional remote to your existing Git repository using the command:
```
git remote add space https://huggingface.co/spaces/HF_USERNAME/SPACE_NAME
```
Verify Remote Addition: To confirm that the "space" remote repository has been successfully added, run the command:
```
git remote
```
This command will display a list of remote repositories, including "space" if it has been added correctly.
Then, force push to sync everything for the first time:
```
git push --force space main
```
#### Step 2: Create GitHub Action for Synchronization
(filename : **.github/workflows/sync_to_hub.yml** )
Next, create a GitHub Action to automatically push your main branch to Spaces. Replace HF_USERNAME with your username and SPACE_NAME with your Space name. Also, [create a GitHub secret](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions#creating-encrypted-secrets-for-an-environment) with your Hugging Face API token. You can find your token under API Tokens on your Hugging Face profile.
```
name: Sync to Hugging Face hub
on:
push:
branches: [main]
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
```
### Step 3: Create Action for File Size Checking
(filename : **.github/workflows/check_file_size.yml**)
Finally, set up an Action that automatically checks the file size of any new pull request. This ensures that you stay within the file size limit of 10MB required for synchronization with HF Spaces.
```
name: Check file size
on:
pull_request:
branches: [main]
workflow_dispatch:
jobs:
sync-to-hub:
runs-on: ubuntu-latest
steps:
- name: Check large files
uses: ActionsDesk/[email protected]
with:
filesizelimit: 10485760 # 10MB limit for HF Spaces
```
By following these steps, you can effectively manage your Spaces with GitHub Actions, ensuring seamless synchronization and efficient development workflows.
For more information, click here : [Managing Spaces with Github Actions](https://huggingface.co/docs/hub/en/spaces-github-actions)