This guide goes through deploying a Satellite site automatically with GitHub Actions on GitHub Pages.
Requirements
- Git repo with Satellite site in it’s root directory. Hosted on GitHub.
Creating a CI Pipeline
Create a .github/workflows/deploy.yml file, and paste the following content in it:
on: push
jobs:
deploy:
name: Deploy to GitHub Pages
runs-on: ubuntu-latest
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.pages-url.outputs.url }}
steps:
- name: Set GitHub Pages URL variable
id: pages-url
run: echo "url=https://${GITHUB_REPOSITORY_OWNER,,}.github.io${GITHUB_REPOSITORY/${GITHUB_REPOSITORY_OWNER/}}" >> $GITHUB_OUTPUT
- uses: actions/checkout@v3
- name: Setup Hugo
uses: peaceiris/actions-hugo@v2
with:
hugo-version: '0.111.3'
- run: hugo --baseURL '${{ steps.pages-url.outputs.url }}'
- uses: actions/upload-pages-artifact@v1
with:
path: public
- uses: actions/deploy-pages@v2
Add the file to Git, and commit it:
git add .github/workflows/deploy.yml
git commit
Running the Pipeline
To run the pipeline and deploy the site, push the commit created in the previous step:
git push
Open GitHub, you should be able to see the pipeline running. Once the pipeline succeeds, you may see your site in GitHub Pages.
On GitHub, in your repository’s page: Go to the github-pages environment, and click “View deploymnet” to see your Pages site.