Skip to content

Commit

Permalink
Add types and documentation for all parameters
Browse files Browse the repository at this point in the history
  • Loading branch information
bastelfreak committed May 23, 2024
1 parent 432a1b7 commit 1f0e26b
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 20 deletions.
2 changes: 0 additions & 2 deletions .puppet-lint.rc
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
--fail-on-warnings
--no-parameter_documentation-check
--no-parameter_types-check
5 changes: 5 additions & 0 deletions .sync.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
.puppet-lint.rc:
enabled_lint_checks:
- parameter_documentation
- parameter_types
32 changes: 16 additions & 16 deletions REFERENCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,72 +82,72 @@ The following parameters are available in the `bolt::project` defined type:
* [`project`](#-bolt--project--project)
* [`owner`](#-bolt--project--owner)
* [`group`](#-bolt--project--group)
* [`manage_user`](#-bolt--project--manage_user)
* [`plans`](#-bolt--project--plans)
* [`environment`](#-bolt--project--environment)
* [`modulepaths`](#-bolt--project--modulepaths)
* [`manage_user`](#-bolt--project--manage_user)

##### <a name="-bolt--project--basepath"></a>`basepath`

Data type: `Stdlib::Absolutepath`


rootdir where the project will be created into

Default value: `'/opt/'`

##### <a name="-bolt--project--project"></a>`project`

Data type: `String[1]`


the name of the project

Default value: `$name`

##### <a name="-bolt--project--owner"></a>`owner`

Data type: `String[1]`


the user that will own the files and run the service

Default value: `$project`

##### <a name="-bolt--project--group"></a>`group`

Data type: `String[1]`


the group for all files

Default value: `$project`

##### <a name="-bolt--project--manage_user"></a>`manage_user`

Data type: `Boolean`



Default value: `true`

##### <a name="-bolt--project--plans"></a>`plans`

Data type: `Array[String[1]]`


a list of all plans we want to run

Default value: `[]`

##### <a name="-bolt--project--environment"></a>`environment`

Data type: `String[1]`


the desired code environment we will use

Default value: `'peadm'`

##### <a name="-bolt--project--modulepaths"></a>`modulepaths`

Data type: `Array[Stdlib::Absolutepath]`


an array of directories where code lives

Default value: `["/etc/puppetlabs/code/environments/${environment}/modules", "/etc/puppetlabs/code/environments/${environment}/site",]`

##### <a name="-bolt--project--manage_user"></a>`manage_user`

Data type: `Boolean`



Default value: `true`

9 changes: 7 additions & 2 deletions manifests/project.pp
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
#
# @summary creates required files for a bolt project. Will create one oneshot service for each plan
#
# @param basepath
# @param project
# @param basepath rootdir where the project will be created into
# @param project the name of the project
# @param owner the user that will own the files and run the service
# @param group the group for all files
# @param plans a list of all plans we want to run
# @param environment the desired code environment we will use
# @param modulepaths an array of directories where code lives
#
# @author Tim Meusel <[email protected]>
#
Expand Down

0 comments on commit 1f0e26b

Please sign in to comment.