Skip to content

Commit

Permalink
formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
fitztrev committed Jul 23, 2024
1 parent 79dc143 commit a1f59ef
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 6 deletions.
16 changes: 11 additions & 5 deletions gitpod-prebuilds.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,36 @@
### What are Gitpod prebuilds?

Gitpod prebuilds is a feature that allows you to prebuild your workspace before you actually need it. This means that when you open your workspace, it will be ready to use immediately, without having to wait for the build process to complete. This can save you a lot of time and make your development process more efficient.

### How lila-docker uses Gitpod prebuilds?

lila-docker uses Gitpod prebuilds to speed up the development process. When gitpod prebuilds are enabled for lila-docker, Gitpod will automatically build the workspace(clone repos, pull docker images, populate db and compile lila) in the background, so that it is ready to use as soon as you open it.

### How to enable Gitpod prebuilds for lila-docker?

To enable Gitpod prebuilds for lila-docker, follow these steps:

1. Fork the lila-docker repository, if you haven't already.
![Fork](https://github.com/user-attachments/assets/45ceef96-8586-4db1-adb1-9213c95dbbe5)
![Fork](https://github.com/user-attachments/assets/45ceef96-8586-4db1-adb1-9213c95dbbe5)

2. After forking the repository, go to https://gitpod.io/repositories and add your fork of the lila-docker repository.
![Add repository](https://github.com/user-attachments/assets/78233aa9-1feb-4970-a8d3-c23536840c6f)
![Add your fork](https://github.com/user-attachments/assets/e654993d-b618-4f9e-a04c-47badee666ef)
![Add repository](https://github.com/user-attachments/assets/78233aa9-1feb-4970-a8d3-c23536840c6f)
![Add your fork](https://github.com/user-attachments/assets/e654993d-b618-4f9e-a04c-47badee666ef)

3. Once the repository is added, go to the repository settings and then to the "Prebuilds" tab and enable prebuilds for the repository, set commit interval to 0 and choose your preferred machine type.
![Enable prebuilds](https://github.com/user-attachments/assets/d2f340a1-0c63-49af-839b-6d4f668d53f5)
![Enable prebuilds](https://github.com/user-attachments/assets/d2f340a1-0c63-49af-839b-6d4f668d53f5)

4. Now, go to https://gitpod.io/prebuilds and run a prebuild for the repository you just added.
![Run prebuild](https://github.com/user-attachments/assets/bf3c4284-23c7-49c5-9329-77b683a8812f)
![Run prebuild](https://github.com/user-attachments/assets/bf3c4284-23c7-49c5-9329-77b683a8812f)

5. Once the prebuild is complete, you can open the workspace and start using it immediately.

That's it! You have now enabled Gitpod prebuilds for lila-docker and can enjoy a faster and more efficient development process.
To start a new workspace with prebuilds, go to https://gitpod.io/workspaces and open the workspace for your fork of the lila-docker repository or you can use `https://gitpod.io/new/#<link-to-your-fork>`. Eg: https://gitpod.io/new/#https://github.com/your-username/lila-docker/tree/main

### Tips for using Gitpod prebuilds with lila-docker

Here are some tips for using Gitpod prebuilds with lila-docker:

- Try to keep your prebuilds up to date by running them regularly by following step 4 and don't forget to update your fork of the lila-docker repository.
- Don't use prebuilds if they are 4-5 days old, we recommend to run a new prebuild or to start a new workspace without prebuilds from the `github.com/lichess-org/lila-docker` repository instead of your fork.
2 changes: 1 addition & 1 deletion pull-all
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ for dir in ./repos/*; do

# if repo is not on main or master branch, don't do anything
if [[ $(git branch --show-current) != "$main_or_master" ]]; then
echo "🔸 not on $main_or_master branch."
echo "🔸 not on $main_or_master branch"
cd "$initial_dir"
continue
fi
Expand Down

0 comments on commit a1f59ef

Please sign in to comment.