Merge pull request #6 from paulrbr-fl/add-dhall-config

dhall: Add a basic dhall type to be able to configure the role

diff --git a/README.md b/README.md
index 71d4acc5951de3017d3c04b68414a12ca2735e8a..5a99be8b035ac4f28d103f12b8d93b95930e535e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -19,6 +19,8 @@ Role Variables
 * `rundeck_remove_missing` Whether to delete jobs present in rundeck and not in file. Defaults to true.
 * `rundeck_jobs_group` the group of job to check for removal
 
+A [dhall](https://dhall-lang.org/) Type representing the roles' variables is available in the `./dhall/Config.dhall` file to help you configure your projects with some type checking.
+
 Dependencies
 ------------
 

diff --git a/dhall/Config.dhall b/dhall/Config.dhall
new file mode 100644 (file)
index 0000000..1c6202c
--- /dev/null
+++ b/dhall/Config.dhall
@@ -0,0 +1,15 @@
+{ rundeck_jobs_path :
+       Text
+, rundeck_project :
+       Text
+, rundeck_api_url :
+       Text
+, rundeck_api_token :
+       Text
+, rundeck_api_version :
+       Optional Natural
+, rundeck_remove_missing :
+       Optional Bool
+, rundeck_jobs_group :
+       Optional Text
+}

diff --git a/dhall/Types.dhall b/dhall/Types.dhall
new file mode 100644 (file)
index 0000000..2a6fa6e
--- /dev/null
+++ b/dhall/Types.dhall
@@ -0,0 +1 @@
+{ Vault = ./Vault.dhall, Config = ./Config.dhall }

diff --git a/dhall/Vault.dhall b/dhall/Vault.dhall
new file mode 100644 (file)
index 0000000..089da4e
--- /dev/null
+++ b/dhall/Vault.dhall
@@ -0,0 +1 @@
+{ apiToken : Text }