Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shalzz/zola-deploy-action
Github action for building a Zola site and deploying to Github Pages
https://github.com/shalzz/zola-deploy-action
actions github github-actions zola
Last synced: 6 days ago
JSON representation
Github action for building a Zola site and deploying to Github Pages
- Host: GitHub
- URL: https://github.com/shalzz/zola-deploy-action
- Owner: shalzz
- License: mit
- Created: 2019-01-13T10:50:32.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-08T10:27:34.000Z (5 months ago)
- Last Synced: 2025-01-11T02:05:35.742Z (13 days ago)
- Topics: actions, github, github-actions, zola
- Language: HTML
- Size: 150 KB
- Stars: 241
- Watchers: 5
- Forks: 92
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-actions - Deploy a Zola site to GitHub Pages
- fucking-awesome-actions - Deploy a Zola site to GitHub Pages
- awesome-workflows - Deploy a Zola site to GitHub Pages
README
# Zola Deploy Action
[](https://actions-badge.atrox.dev/shalzz/zola-deploy-action/goto)
A GitHub action to automatically build and deploy your [zola] site to the master
branch as GitHub Pages.
## Table of Contents
- [Usage](#usage)
- [Environment Variables](#environment-variables)
- [Custom Domain](#custom-domain)
## Usage
In your repository **Settings > Actions > General**, in Workflow permissions, make sure that `GITHUB_TOKEN` has **Read and Write permissions**.
This example will build and deploy to gh-pages on push to the main branch.
```yml
name: Zola on GitHub Pages
on:
push:
branches:
- main
jobs:
build:
name: Publish site
runs-on: ubuntu-latest
steps:
- name: Checkout main
uses: actions/checkout@v4
- name: Build and deploy
uses: shalzz/[email protected]
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
This example will build and deploy to gh-pages branch on a push to the main branch,
and it will build only on pull requests.
```yml
name: Zola on GitHub Pages
on:
push:
branches:
- main
pull_request:
jobs:
build:
runs-on: ubuntu-latest
if: github.ref != 'refs/heads/main'
steps:
- name: Checkout main
uses: actions/checkout@v4
- name: Build only
uses: shalzz/[email protected]
env:
BUILD_DIR: docs
BUILD_ONLY: true
BUILD_FLAGS: --drafts
# A GitHub token is not necessary when BUILD_ONLY is true
# GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
build_and_deploy:
runs-on: ubuntu-latest
if: github.ref == 'refs/heads/main'
steps:
- name: Checkout main
uses: actions/checkout@v4
- name: Build and deploy
uses: shalzz/[email protected]
env:
BUILD_DIR: docs
PAGES_BRANCH: gh-pages
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
## Environment Variables
* `PAGES_BRANCH`: The git branch of your repo to which the built static files will be pushed. Default is `gh-pages` branch
* `REPOSITORY`: The target repository to push to. Default is `GITHUB_REPOSITORY`(current repository). Set this variable if you want to deploy to other repo.
* `BUILD_DIR`: The path from the root of the repo where we should run the `zola build` command. Default is `.` (current directory)
* `OUT_DIR`: The build output directory of `zola build`. Default is `public`
* `BUILD_FLAGS`: Custom build flags that you want to pass to zola while building. (Be careful supplying a different build output directory might break the action).
* `BUILD_ONLY`: Set to value `true` if you don't want to deploy after `zola build`.
* `BUILD_THEMES`: Set to false to disable fetching themes submodules. Default `true`.
* `CHECK_LINKS`: Set to `true` to check links with `zola check`.
* `CHECK_FLAGS`: Custom check flags that you want to pass to `zola check`.
* `GITHUB_HOSTNAME`: The Github hostname to use in your action. This is to account for Enterprise instances where the base URL differs from the default, which is `github.com`.
## Custom Domain
If you're using a custom domain for your GitHub Pages site put the CNAME
in `static/CNAME` so that zola puts it in the root of the public folder
which is where GitHub expects it to be.
[zola]: https://github.com/getzola/zola
##
Thanks and enjoy your day!
