github-workflow-controller/README.md

1.1 KiB

A plugin to A simple plugin to control GitHub workflows.

Usage

The following settings changes this plugin's behavior.

  • param1 (optional) does something.
  • param2 (optional) does something different.

Below is an example .drone.yml that uses this plugin.

kind: pipeline
name: default

steps:
- name: run itsblue.dev/plugins/github-workflow-controller plugin
  image: itsblue.dev/plugins/github-workflow-controller
  pull: if-not-exists
  settings:
    param1: foo
    param2: bar

Building

Build the plugin binary:

scripts/build.sh

Build the plugin image:

docker build -t itsblue.dev/plugins/github-workflow-controller -f docker/Dockerfile .

Testing

Execute the plugin from your current working directory:

docker run --rm -e PLUGIN_PARAM1=foo -e PLUGIN_PARAM2=bar \
  -e DRONE_COMMIT_SHA=8f51ad7884c5eb69c11d260a31da7a745e6b78e2 \
  -e DRONE_COMMIT_BRANCH=master \
  -e DRONE_BUILD_NUMBER=43 \
  -e DRONE_BUILD_STATUS=success \
  -w /drone/src \
  -v $(pwd):/drone/src \
  itsblue.dev/plugins/github-workflow-controller