Skip to content
check

GitHub Action

Deploy Jekyll Site

1.0.5 Latest version

Deploy Jekyll Site

check

Deploy Jekyll Site

Build and deploy jekyll site to Github Pages

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Deploy Jekyll Site

              
  uses: sujaykundu777/[email protected]
Learn more about this action in sujaykundu777/jekyll-deploy-action

Choose a version

jekyll-deploy

A Github Action to build and deploy Jekyll site to Github Pages

The Action will build a production build of your jekyll site in gh-pages branch on every push. Very helpful, when you want to use jekyll plugins which are not supported by Github Pages Yet.

Build Screenshot

Example usage

You need to set build folder as God demands, add the following in your site's _config.yml :

destination: ./build

And, put the following inside yourjekyllsite/.github/workflows/main.yml

name: Jekyll Deploy

on:
  push:
    branches: [ master ]
  pull_request:
    branches: [ master ]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
    - name: Deploy Jekyll Site with Ruby 3.3.x
      uses: sujaykundu777/[email protected]
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        GITHUB_REPOSITORY: ${{ secrets.GITHUB_REPOSITORY }}
        GITHUB_ACTOR: ${{ secrets.GITHUB_ACTOR }}