summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Mulai <64560561+mulai-dev@users.noreply.github.com> 2021-07-30 03:31:47 +0700
committerGravatar GitHub <noreply@github.com> 2021-07-29 16:31:47 -0400
commit09fefead88e130f5f2ca8a8d17b8662b5c82bbb1 (patch)
tree168b954ad55cf661c933df356b3d75df8395fd24
parent6eeafac715aaa077f07dd12d0609301a807a0705 (diff)
downloadastro-09fefead88e130f5f2ca8a8d17b8662b5c82bbb1.tar.gz
astro-09fefead88e130f5f2ca8a8d17b8662b5c82bbb1.tar.zst
astro-09fefead88e130f5f2ca8a8d17b8662b5c82bbb1.zip
Fix Github Action setup (#934)
-rw-r--r--docs/src/pages/guides/deploy.md13
1 files changed, 7 insertions, 6 deletions
diff --git a/docs/src/pages/guides/deploy.md b/docs/src/pages/guides/deploy.md
index 63155add5..d993aafec 100644
--- a/docs/src/pages/guides/deploy.md
+++ b/docs/src/pages/guides/deploy.md
@@ -68,11 +68,12 @@ By default, the build output will be placed at `dist/`. You may deploy this `dis
### GitHub Actions
-1. Set the correct `buildOptions.site` in `astro.config.mjs`
-2. Create the file `.github/workflows/main.yml` and add in the yaml below. Make sure to edit in your own details.
-3. In Github go to Settings > Developer settings > Personal Access tokens. Generate a new token with repo permissions.
-4. In the astro project repo (not \<YOUR USERNAME\>.github.io) go to Settings > Secrets and add your new personal access token with the name `API_TOKEN_GITHUB`.
-5. When you push changes to the astro project repo CI will deploy them to \<YOUR USERNAME\>.github.io for you.
+1. In the astro project repo, create `gh-pages` branch then go to Settings > Pages and set to `gh-pages` branch for Github Pages and set directory to `/` (root).
+2. Set the correct `buildOptions.site` in `astro.config.mjs`
+3. Create the file `.github/workflows/main.yml` and add in the yaml below. Make sure to edit in your own details.
+4. In Github go to Settings > Developer settings > Personal Access tokens. Generate a new token with repo permissions.
+5. In the astro project repo (not \<YOUR USERNAME\>.github.io) go to Settings > Secrets and add your new personal access token with the name `API_TOKEN_GITHUB`.
+6. When you push changes to the astro project repo CI will deploy them to \<YOUR USERNAME\>.github.io for you.
```yaml
# Workflow to build and deploy to your Github Pages repo.
@@ -124,7 +125,7 @@ jobs:
destination-repository-name: ${{ env.deployToRepo }}
user-email: ${{ env.githubEmail }}
commit-message: Deploy ORIGIN_COMMIT
- target-branch: main
+ target-branch: gh-pages
```
### Travis CI