Description

The netlify Publisher allows you to upload your site to Netlify.

To use the netlify publisher, you'll need to provide Orchid with a netlifyToken containing a Personal Access Token from Netlify. Since PATs are confidential and allow anyone who has it complete access to your account, you should set this as an environment variable and add it to your Gradle orchid config from that variable rather than committing it to source control.

orchid {
    ...
    args = ["netlifyToken ${System.getenv('NETLIFY_TOKEN')}"]
}

After your PAT is set up, you'll need to create a new site on Netlify, and set the domain as the siteId in your publisher config. And that's it, Orchid will do the hard work of authenticating with Netlify and determining which files to upload.

Example Usage

services:
  publications: 
    stages: 
      - type: netlify
        siteId: 'orchid.netlify.com'

API Documentation

Upload your site directly to Netlify, while using your favorite CI platform.

Default Config
# config.yml
...
services:
  publications:
    stages:
      netlify:
        siteId: empty string
Key Type Default Value Description
siteId String empty string

Your Netlify site ID or domain (ie. orchid.netlify.com).

Key Type Default Value Description
allData Map<String, Object> {}

All options passed to this object.

dry boolean false
order int 0

Manually set the order in which this publisher executes

Key Type Description
allPublishers Site Config

Configure this item with additional options merged in from config.yml, from the object at the archetype key. Dots in the key indicate sub-objects within the site config.

See Also:

Edit this page