You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
-43Lines changed: 0 additions & 43 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -110,49 +110,6 @@ In this example the automated release prep workflow is triggered every Saturday
110
110
| required | The default list of files or paths for PDK to ignore when building a module package.
111
111
| paths | Defines additional files or paths for PDK to ignore when building a module package.
112
112
113
-
### .travis.yml
114
-
115
-
>[Travis CI](https://travis-ci.org/) is a hosted continuous integration platform that is free for all open source projects hosted on Github.
116
-
We can trigger automated builds with every change to our code base in the main branch, other branches or even a pull request.
117
-
Travis uses a .travis.yml file in the root of your repository to learn about your project and how you want your builds to be executed.
118
-
| Key | Description |
119
-
| :------------- |:--------------|
120
-
| os | Set to an array of operating systems to test. See the [TravisCI documentation](https://docs.travis-ci.com/user/multi-os/) for more details. |
121
-
| dist | If specified, it will set the dist attribute. See the [TravisCI documentation](https://docs.travis-ci.com/user/reference/overview/#virtualisation-environment-vs-operating-system) for more details. |
122
-
| simplecov |Set to `true` to enable collecting ruby code coverage.|
123
-
| ruby\_versions |Define the ruby versions on which you want your builds to be executed.|
124
-
| bundler\_args |Define any arguments you want to pass through to bundler. The default is `--without system_tests` which avoids installing unnecessary gems.|
125
-
| env |Allows you to add new travis job matrix entries based on the included environment variables, one per `env` entry; for example, for adding jobs with specific `PUPPET_GEM_VERSION` and/or `CHECK` values. See the [Travis Environment Variables](https://docs.travis-ci.com/user/environment-variables) documentation for details.|
126
-
| global\_env |Allows you to set global environment variables which will be defined for all travis jobs; for example, `PARALLEL_TEST_PROCESSORS` or `TIMEOUT`. See the [Travis Global Environment Variables](https://docs.travis-ci.com/user/environment-variables/#Global-Variables) documentation for details.|
127
-
|docker\_sets |Allows you to configure sets of docker to run your tests on. For example, if I wanted to run on a docker instance of Ubuntu I would add `set:docker/ubuntu-14.04` to my docker\_sets attribute. The docker_sets is a hash that supports the 'set', 'testmode', and 'collection' keys. |
128
-
|docker\_sets['set']| This should reference the docker nodeset that you wish to run. |
129
-
|docker\_sets['testmode']| This configures the `BEAKER_TESTMODE` to use when testing the docker instance. The two options are `apply` and `agent` if omitted `apply` is used by default. |
130
-
|docker_sets['collection]| This configures the `BEAKER_PUPPET_COLLECTION` to use when testing the docker instance. The default is `puppet6`.
131
-
|docker_defaults |Defines what values are used as default when using the `docker_sets` definition. Includes ruby version, sudo being enabled, the distro, the services, the env variables and the script to execute.|
132
-
|stages |Allows the specification of order and conditions for travis-ci build stages. See [Specifying Stage Order and Conditions](https://docs.travis-ci.com/user/build-stages/#specifying-stage-order-and-conditions).|
133
-
|before_install_pre |Add install steps to the start of `before_install`. |
134
-
|before_install_post |Add install steps to the end of `before_install`. |
135
-
|includes |Ensures that the .travis file includes the following checks by default: Rubocop, Puppet Lint, Metadata Lint.|
136
-
|remove_includes |Allows you to remove includes set in `config_defaults.yml`.|
137
-
|branches |Allows you to specify the only branches that travis will run builds on. The default branches are `main` and `/^v\d/`. |
138
-
|branches_except |Allows you to specify branches that travis will not build on.|
139
-
|remove_branches |Allows you to remove default branches set in config_defaults.yml.|
140
-
|notifications |Allows you to specify the notifications configuration in the .travis.yml file.|
141
-
|remove_notifications |Allows you to remove default branches set in config_defaults.yml.|
142
-
|deploy_to_forge|Allows you to change the automatic deployment of modules to the forge. Sub keys are `enabled` and `tag_regex` which are detailed below|
143
-
|deploy_to_forge\\**enabled**|Allows you to enable or disable automatic forge deployments. Default is true|
144
-
|deploy_to_forge\\**tag_regex**|Allows you to use a regular expression to define which tags will trigger a deployment. The default is `^v\d`|
145
-
|before_deploy|An array which can allow a user to specify the commands to run before kicking off a deployment. See [https://docs.travis-ci.com/user/deployment/releases/#setting-the-tag-at-deployment-time].|
146
-
|use_litmus| By default it is disabled. Set to `true` to configure travis to use Litmus testing tool for acceptance testing jobs with default values.|
147
-
|litmus|Allows you to update default config values. Its sub keys are `provision_list`, `puppet_collection`, `rvm`, `install_wget` which are detailed below.|
148
-
|litmus\\**puppet_collection**|Allows you to specify the puppet version under test. Default test are ran on _puppet 5_ and _puppet 6_.|
149
-
|litmus\\**provision_list**|Allows you to specify the platforms list under test. Default test are ran on platformes defined in provision.yaml file under _travis_deb_ and _travis_el_|
150
-
|litmus\\**rvm**|Allows you to specify the ruby version under test. Default it is set to _2.5.7_|
151
-
|litmus\\**install_wget**|Allows you to enable automatic installation of wget on the platform under test. We need this when installing agent on travis_deb platforms. Default it is disabled. |
152
-
|litmus\\**complex\\collection**|Allows you to specify multiple collections of `puppet_collection` and `provision_list`, allowing you to set certain OS to only run on certain Puppet versions. |
153
-
|user|This string needs to be set to the Puppet Forge user name. To enable deployment the secure key also needs to be set.|
154
-
|secure|This string needs to be set to the encrypted password to enable deployment. See [https://docs.travis-ci.com/user/encryption-keys/#usage](https://docs.travis-ci.com/user/encryption-keys/#usage) for instructions on how to encrypt your password.|
155
-
156
113
### .yardopts
157
114
158
115
>[YARD](https://yardoc.org/) is a documentation generation tool for the Ruby programming language. It enables the user to generate consistent, usable documentation that can be exported to a number of formats very easily, and also supports extending for custom Ruby constructs such as custom class level definitions.
0 commit comments