From eddef2e4ff18a9436f8029223395a62ee8e34f40 Mon Sep 17 00:00:00 2001 From: George <31376482+george-gca@users.noreply.github.com> Date: Wed, 13 Mar 2024 11:24:17 -0300 Subject: [PATCH] Make clear that you should not touch `gh-pages` branch --- INSTALL.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index fc50d44468b4..c3488b9bb526 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -91,29 +91,29 @@ To see the template running, open your browser and go to `http://localhost:4000` ## Deployment Deploying your website to [GitHub Pages](https://pages.github.com/) is the most popular option. -Starting version [v0.3.5](https://github.com/alshedivat/al-folio/releases/tag/v0.3.5), **al-folio** will automatically re-deploy your webpage each time you push new changes to your repository! :sparkles: +Starting version [v0.3.5](https://github.com/alshedivat/al-folio/releases/tag/v0.3.5), **al-folio** will automatically re-deploy your webpage each time you push new changes to your repository **main branch**! :sparkles: ### For personal and organization webpages 1. The name of your repository **MUST BE** `.github.io` or `.github.io`. 2. In `_config.yml`, set `url` to `https://.github.io` and leave `baseurl` empty. 3. Set up automatic deployment of your webpage (see instructions below). -4. Make changes, commit, and push! +4. Make changes to your main branch, commit, and push! 5. After deployment, the webpage will become available at `.github.io`. ### For project pages 1. In `_config.yml`, set `url` to `https://.github.io` and `baseurl` to `//`. 2. Set up automatic deployment of your webpage (see instructions below). -3. Make changes, commit, and push! +3. Make changes to your main branch, commit, and push! 4. After deployment, the webpage will become available at `.github.io//`. ### Enabling automatic deployment 1. Click on **Actions** tab and **Enable GitHub Actions**; do not worry about creating any workflows as everything has already been set for you. 2. Go to `Settings -> Actions -> General -> Workflow permissions`, and give `Read and write permissions` to GitHub Actions -3. Make any other changes to your webpage, commit, and push. This will automatically trigger the **Deploy** action. -4. Wait for a few minutes and let the action complete. You can see the progress in the **Actions** tab. If completed successfully, in addition to the `master` branch, your repository should now have a newly built `gh-pages` branch. +3. Make any other changes to your webpage, commit, and push to your main branch. This will automatically trigger the **Deploy** action. +4. Wait for a few minutes and let the action complete. You can see the progress in the **Actions** tab. If completed successfully, in addition to the `master` branch, your repository should now have a newly built `gh-pages` branch. **Do NOT touch this branch!** 5. Finally, in the **Settings** of your repository, in the Pages section, set the branch to `gh-pages` (**NOT** to `master`). For more details, see [Configuring a publishing source for your GitHub Pages site](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#choosing-a-publishing-source). If you keep your site on another branch, open `.github/workflows/deploy.yml` **on the branch you keep your website on** and change `on->push->branches` and `on->pull\_request->branches` to the branch you keep your website on. This will trigger the action on pulls/pushes on that branch. The action will then deploy the website on the branch it was triggered from. @@ -141,7 +141,7 @@ $ purgecss -c purgecss.config.js which will replace the css files in the `_site/assets/css/` folder with the purged css files. -**Note:** Make sure to correctly set the `url` and `baseurl` fields in `_config.yml` before building the webpage. If you are deploying your webpage to `your-domain.com/your-project/`, you must set `url: your-domain.com` and `baseurl: /your-project/`. If you are deploying directly to `your-domain.com`, leave `baseurl` blank. +**Note:** Make sure to correctly set the `url` and `baseurl` fields in `_config.yml` before building the webpage. If you are deploying your webpage to `your-domain.com/your-project/`, you must set `url: your-domain.com` and `baseurl: /your-project/`. If you are deploying directly to `your-domain.com`, leave `baseurl` blank, **do not delete it**. ### Deployment to a separate repository (advanced users only)