https://github.com/jayvdb/jekyll-netlify

Jekyll plugin for Netlify
https://github.com/jayvdb/jekyll-netlify

ci environment-variables jekyll-plugin netlify

Last synced: 3 months ago
JSON representation

Jekyll plugin for Netlify

• Host: GitHub
• URL: https://github.com/jayvdb/jekyll-netlify
• Owner: jayvdb
• License: mit
• Created: 2017-11-10T19:19:13.000Z (about 7 years ago)
• Default Branch: main
• Last Pushed: 2021-10-27T00:37:03.000Z (over 3 years ago)
• Last Synced: 2024-10-15T20:43:53.979Z (4 months ago)
• Topics: ci, environment-variables, jekyll-plugin, netlify
• Language: Ruby
• Size: 34.2 KB
• Stars: 18
• Watchers: 5
• Forks: 5
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/jayvdb/jekyll-netlify.svg?branch=master)](https://travis-ci.org/jayvdb/jekyll-netlify)

[![Gem Version](https://badge.fury.io/rb/jekyll-netlify.svg)](https://badge.fury.io/rb/jekyll-netlify)

# Jekyll::Netlify

Expose Netlify deploy information to Jekyll templates

and set `site.environment=production`.

```

{{site.netlify.branch}} # => Will return the branch name

{{site.netlify.pull_request.url}} # => Will return http://github.com/foo/bar/pulls/23

```

## Installation

Add to your `Gemfile`:

```

group :jekyll_plugins do

  gem "jekyll-netlify"

end

```

For older versions of Jekyll, add to your `_config.yml`:

```yml

plugins:

  - jekyll-netlify

```

## Usage

This plugin adds hash of `site.netlify` containing

[Build Environment information](https://www.netlify.com/docs/continuous-deployment/#build-environment-variables):

- repository_url (`git@...`)

- branch

- pull_request: (false; true for BitBucket; or Hash for GitHub and GitLab)

  - id

  - url

- head

- commit

- context

- deploy_url

- url

- deploy_prime_url

- webhook

  - title

  - url

  - body