GitHub Pages

by drone-plugins

sourcereadmeimageOriginal doc

The GitHub Pages plugin is used to publish static websites to GitHub. The following configuration uses the gh-pages plugin to publish a website.

Example

kind: pipeline
name: default

steps:
- name: publish  
  image: plugins/gh-pages
  settings:
    username: octocat
    password: p455w0rd
    pages_directory: public/

Properties

• username

  stringrequired

  GitHub username for pushing changes

  Default: none

• password

  stringrequired

  GitHub password for pushing changes

  Secret recommended

  Default: none

• ssh_key

  stringoptional

  SSH key to use for pushing changes

  Secret recommended

  Default: none

• upstream_name

  stringoptional

  GitHub upstream target

  Default: origin

• target_branch

  stringoptional

  GitHub target branch

  Default: gh-pages

• temporary_base

  stringoptional

  Temporary directory to pull gh-pages branch

  Default: .tmp

• pages_directory

  stringrequired

  The directory of content to publish

  Default: docs