Merge pull request #2 from Telefonica/add_reference_file

add reference file

Author: Shimon

REFERENCE.md

@@ -0,0 +1,128 @@
+# Reference
+
+## Table of Contents
+
+**Classes**
+
+* [`github_actions_runner`](#github_actions_runner)
+* [`github_actions_runner::install`](#github_actions_runner_install)
+* [`github_actions_runner::config`](#github_actions_runner_config)
+* [`github_actions_runner::service`](#github_actions_runner_service)
+
+## Classes
+
+### github_actions_runner
+
+Guides the basic setup and installation of GitHub actions runner on your system.
+
+You can read more about self-hosted actions runner [here](https://docs.github.com/en/free-pro-team@latest/actions/hosting-your-own-runners/about-self-hosted-runners)
+
+#### Parameters
+
+The following parameters are available in the `github_actions_runner` class.
+
+##### `ensure`
+
+Data type: `Enum['present', 'absent']]`
+Enum, Determine if to add or remove the resource.
+
+##### `base_dir_name`
+
+Data type: `Absolutepath`
+Location of the base directory for actions runner to be installed.
+
+##### `repo_name`
+
+Data type: `Optional[String]`
+
+actions runner github repository name to serve.
+Default value: `undef`
+
+##### `org_name`
+
+Data type: `String`
+
+actions runner github organization name.
+
+##### `labels`
+
+Data type: `Optional[Array[String]]`
+
+A list of costum lables to add to a actions runner host.
+
+Default value: `undef`
+
+##### `hostname`
+
+Data type: `String`
+
+actions runner name
+
+Default value: $::facts['hostname']
+
+##### `personal_access_token`
+
+Data type: `String`
+
+GitHub Personal Access Token with admin permission on the repositories or the organization.
+
+##### `package_name`
+
+Data type: `String`
+
+GitHub Actions runner official package name.
+
+You can find the package names  [here](https://github.com/actions/runner/releases)
+
+**Example**:
+
+```actions-runner-linux-x64
+```
+
+##### `package_ensure`
+
+Data type: `String`
+
+GitHub Actions runner version to be used.
+
+You can find latest versions [here](https://github.com/actions/runner/releases)
+
+**Example**:
+
+```2.272.0
+```
+
+##### `repository_url`
+
+Data type: `String`
+
+A base URL to download GitHub actions runner.
+
+**Example**:
+
+```https://github.com/actions/runner/releases/download
+```
+
+##### `user`
+
+Data type: `String`
+
+User to be used in Service and directories.
+
+##### `group`
+
+Data type: `String`
+
+Group to be used in Service and directories.
+
+### github_actions_runner::install
+
+Install the files and packages for the module.
+
+### github_actions_runner::config
+
+Main path configuration of the module installation.
+
+### github_actions_runner::service
+
+The service setup for this module.

manifests/init.pp

@@ -26,7 +26,7 @@
 #  String, actions runner name.
 #
 # * personal_access_token
-# String, GitHub PAT with admin permission on the repositories or the origanization .
+# String, GitHub PAT with admin permission on the repositories or the origanization.
 #
 # * package_name
 # String, GitHub Actions runner offical package name.
@@ -35,7 +35,7 @@
 # String, GitHub Actions runner version to be used.
 #
 # * repository_url
-# String, URL to download GutHub actions runner.
+# String, URL to download GitHub actions runner.
 #
 # * user
 # String, User to be used in Service and directories.