From 825c25b00f50fce9f1961ff4a5558c644a58662e Mon Sep 17 00:00:00 2001 From: Reid Vandewiele Date: Tue, 11 Jun 2019 11:32:29 -0700 Subject: [PATCH] Make the README slightly better --- README.md | 27 +++++++++++++++++++++++---- metadata.json | 2 +- 2 files changed, 24 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 7af572f..c1ec0b8 100644 --- a/README.md +++ b/README.md @@ -20,17 +20,36 @@ bolt task run taskplan \ To create a plan-specific tailored taskplan task, use something like the following: +```json +{ + "description": "Sample plan-specific tailored taskplan task", + "parameters": { + "my_plans_parameter": { + "type": "String", + "description": "The first parameter from the plan" + }, + "my_plans_other_parameter": { + "type": "Integer", + "description": "Another parameter from the plan" + } + }, + "input_method": "stdin", + "files": [ + "taskplan/tasks/init.rb" + ] +} +``` + ```ruby #!/opt/puppetlabs/puppet/bin/ruby require 'json' $params = { - 'params' => JSON.parse(STDIN.read), - 'plan' => 'example::myplan', - 'arguments' => [], + 'params' => JSON.parse(STDIN.read), + 'plan' => 'example::myplan', } -taskplanrb = File.join($params['params']['_installdir'], 'util', 'files', 'taskplan.rb') +taskplanrb = File.join($params['params']['_installdir'], 'taskplan', 'tasks', 'init.rb') load(taskplanrb) ``` diff --git a/metadata.json b/metadata.json index 6f025bd..fb89b5f 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "reidmv-taskplan", - "version": "0.2.0", + "version": "0.2.1", "author": "Reid Vandewiele", "summary": "Run Puppet task plans, using Bolt, via a task", "license": "Apache-2.0",