https://github.com/zbrox/zola-deploy-action

Github action for building a Zola site and deploying to Github Pages
https://github.com/zbrox/zola-deploy-action

Last synced: 8 days ago
JSON representation

Github action for building a Zola site and deploying to Github Pages

• Host: GitHub
• URL: https://github.com/zbrox/zola-deploy-action
• Owner: zbrox
• Fork: true (te-online/zola-deploy-action)
• Created: 2019-09-17T08:55:41.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2021-01-09T15:59:02.000Z (almost 4 years ago)
• Last Synced: 2024-10-31T10:42:20.420Z (14 days ago)
• Language: Shell
• Size: 15.6 KB
• Stars: 2
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Zola Deploy Action

[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fzbrox%2Fzola-deploy-action%2Fbadge&style=flat)](https://actions-badge.atrox.dev/zbrox/zola-deploy-action/goto)

![GitHub Release](https://img.shields.io/github/v/release/zbrox/zola-deploy-action?sort=semver)

A GitHub action to automatically build and deploy your [zola] site to a branch in the repository to be used for GitHub Pages.

## Table of Contents

 - [Usage](#usage)

 - [Environment variables](#environment-variables)

 - [Custom Domain](#custom-domain)

## Usage

In `.github/workflows` you can put any `.yml` file and put the following contents inside.

```

on:

  push:

    branches:

      - master

name: Build and deploy on push

jobs:

  build:

    name: zbrox/zola-deploy-action

    runs-on: ubuntu-latest

    steps:

    - uses: actions/checkout@master

    - name: zbrox/zola-deploy-action

      uses: zbrox/zola-deploy-action@master

      env:

        TOKEN: ${{ secrets.TOKEN }}

```

The following workflow will execute only when pushing to the `master` branch and will publish the `zola` generated pages to the `gh-pages` branch.

## Environment Variables

 * `TOKEN`: [Personal Access key](https://github.com/settings/tokens) with the scope `public_repo`, we need this

    to push the site files back to the repo.

    

    ( Actions already provides a `GITHUB_TOKEN` which is an installation token and does not trigger a GitHub Pages builds hence we need a personal access token )

* `PAGES_BRANCH`: The git branch of your repo to which the built static files will be pushed. Default is `gh-pages` branch

## 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