CI/CD for Jekyll

Hint

📚 Learn more about Jekyll action features, integrations and alternatives.

With Buddy, you can create a pipeline that builds, tests, and deploys Jekyll websites on a push to Git. The configuration is super simple and takes 10 to 15 minutes.

Image loading...Jekyll pipeline exampleJekyll pipeline example

1. Select your Git repository

Buddy supports all popular Git hosting providers, including GitHub, Bitbucket, and GitLab. You can also use your own private Git server, or host code directly on Buddy.

Image loading...Supported Git providersSupported Git providers

2. Add a new delivery pipeline

Enter the pipeline's name, select the trigger mode, and define the branch from which Buddy will fetch your code:

Image loading...Exemplary pipeline settingsExemplary pipeline settings

Hint

Trigger modes

  • Manual (on click) — recommended for Production
  • On push (automatic) — recommended for Development
  • Recurrently (on time interval) — recommended for Staging/Testing
Success
Event-based triggers allow you to run pipelines whenever a push is made to any branch in the repository, or whenever a branch, tag or a pull request is created or deleted. Image loading...On event pipeline trigger modeOn event pipeline trigger mode

3. Add actions

Buddy lets you choose from dozens of predefined actions. In this example, we'll add 3 actions that will perform the following tasks:

  • Build and test your Jekyll website
  • Upload website to server
  • Send notification to Slack

3.1 Build and test your Jekyll website

Success
Build actions in Buddy are run in isolated containers run from official Docker images. When the pipeline is run, Buddy pulls the container, runs build commands, and uploads the results to the pipeline filesystem.

Look up and click Jekyll on the action list to add it to the pipeline:

Image loading...Action listAction list

The Run tab lets you determine the commands to execute. The default command is:

jekyll build$

Image loading...Default build commands for JekyllDefault build commands for Jekyll

3.1.2 Jekyll version

You can change Jekyll version and install missing packages & tools in the runtime environment tab:

Image loading...Jekyll action imageJekyll action image

Tip
If your tests require a database to run, you can attach it in the Services tab: Image loading...Services tabServices tab

3.2 Deploy website to server

The website is ready for upload. Head to the Transfer section and select your deploy action (SFTP in our case):

Image loading...File transfer actionsFile transfer actions

When adding the action you can choose what and where should be uploaded:

Image loading...Setting up an SFTP actionSetting up an SFTP action

3.3 Send notification to Slack

You can configure Buddy to send your team a message after the deployment. In this example we'll use Slack:

Image loading...Notification actionsNotification actions

Hint
If you add this action in the On Failure tab, Buddy will only send the message if something goes wrong with your build or deployment. Image loading...On failure notificationOn failure notification

4. Summary

Congratulations! You have just automated your entire delivery process. Make a push to the selected branch and watch Buddy fetch, build, and deploy your project. With Continuous Delivery applied, you can now focus on what's really important: developing awesome apps! 🔥

Success
Bear in mind that this article is only a brief example of what Buddy can do. You can create additional pipelines for staging and production environments, integrate with your favorite services (AWS, Google, Azure), trigger tests on pull requests, build Docker images, and push them to the registry—the possibilities are unlimited.
Tip
If you want us to create a delivery pipeline for your project, drop a line to support@buddy.works – we'll be happy to help!
Last update:
Sep 23, 2024