This is merely a skeleton plugin that plugin developers can fork to get quickly
started with writing task plugins for GoCD. It works out of the box, but you should change
it to do something besides executing curl
.
All the documentation is hosted at https://plugin-api.gocd.io/current/tasks.
- Edit the file
build.gradle
to change the plugin id, description and some other metadata. - Edit the file
settings.gradle
to change the name of this project. - Edit the
GetConfigRequest.java
class to add any configuration fields that should be shown in the view. - Edit the
TaskConfig.java
file which contains the model for your task configuration. - Edit the
task.template.html
file which contains the view for the plugin settings page of your plugin. - Edit the
ValidateRequest.java
class to perform validation of the task configuration as performed by a user. - Edit the
ExecuteRequest.java
andCurlTaskExecutor.java
class to execute the task, and pipe stdout/stderr correctly.
To build the jar, run ./gradlew clean test assemble
Copyright 2017 ThoughtWorks, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.