https://github.com/BryanSchuetz/jekyll-deploy-gh-pages

A GitHub Action for building a Jekyll site (with custom plugins) and deploying it back to your gh-pages branch.
https://github.com/BryanSchuetz/jekyll-deploy-gh-pages

actions github-actions github-pages jekyll

Last synced: about 1 month ago
JSON representation

A GitHub Action for building a Jekyll site (with custom plugins) and deploying it back to your gh-pages branch.

• Host: GitHub
• URL: https://github.com/BryanSchuetz/jekyll-deploy-gh-pages
• Owner: BryanSchuetz
• Created: 2018-12-05T17:00:05.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2020-07-24T15:55:32.000Z (about 4 years ago)
• Last Synced: 2024-07-09T08:45:52.099Z (2 months ago)
• Topics: actions, github-actions, github-pages, jekyll
• Language: Shell
• Homepage:
• Size: 25.4 KB
• Stars: 116
• Watchers: 4
• Forks: 60
• Open Issues: 11
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-actions - Build a Jekyll site—with Custom Jekyll Plugins & Build Scripts—and deploy it back to the Gh-Pages Branch
• fucking-awesome-actions - Build a Jekyll site—with Custom Jekyll Plugins & Build Scripts—and deploy it back to the Gh-Pages Branch
• awesome-workflows - Build a Jekyll site—with Custom Jekyll Plugins & Build Scripts—and deploy it back to the Gh-Pages Branch

README

        

> **This action has been updated from the first beta version of GH Actions to the new beta version of GH Actions. See below for the new structure required in your workflow.**

# A GitHub Action for Custom Jekyll Builds on GitHub Pages

A GitHub Action for building and deploying a Jekyll repo back to its `gh-pages` branch. 

**Why not just let GitHub Pages build it? Because this way we can use our own custom Jekyll plugins and build scripts.**

## Secrets

* `GITHUB_TOKEN`: An access key which scoped to the repository - we need this to push the built site files back to the repo. This is generated for you on each workflow run——see usage in [example](#example). (GitHub Provides)

  

## Environment Variables

* `GITHUB_ACTOR`: Username of repo owner or object initiating the action (GitHub Provides)

* `GITHUB_REPO`: Owner/Repository (GitHub Provides)

## Example

```yml

name: Jekyll Deploy

on: [push]

jobs: 

  build_and_deploy:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v1

      - name: Build & Deploy to GitHub Pages

        env: 

          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

          GITHUB_REPOSITORY: ${{ secrets.GITHUB_REPOSITORY }}

          GITHUB_ACTOR: ${{ secrets.GITHUB_ACTOR }}

        uses: BryanSchuetz/jekyll-deploy-gh-pages@master

```

Clones the repo, builds the site, and commits it back to the `gh-pages` branch of the repository. That's it. Just add the above example to a `main.yml` file in the `.github/workflows` directory of your repository—see caveats below. 

## Caveats

* `destination:` should be set to `./build` in your `_config.yml` file—as God demands.

* A `Gemfile` is required. This must include `jekyll` and any other custom gems.