Skip to content

Commit 0250103

Browse files
committed
(doc) Add and test for current REFERENCE.md using puppet-strings
Adds a REFERENCE.md generated with puppet-strings, and minimal changes needs to validate in the main pr_testing workflow that a given pr's REFERENCE.md is up to date with the state of the module.
1 parent f059cce commit 0250103

File tree

4 files changed

+92
-0
lines changed

4 files changed

+92
-0
lines changed

.github/workflows/pr_testing.yaml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,19 @@ jobs:
2626
- name: Run ShellCheck
2727
run: shellcheck -x tasks/*.sh files/*.sh
2828

29+
reference-check:
30+
runs-on: ubuntu-latest
31+
steps:
32+
- uses: actions/checkout@v4
33+
- uses: ruby/setup-ruby@v1
34+
with:
35+
ruby-version: '3.4'
36+
bundler-cache: true
37+
- name: Regenerate REFERENCE.md
38+
run: bundle exec puppet strings generate --format markdown
39+
- name: Check whether REFERENCE.md has uncommitted changes
40+
run: git diff --exit-code REFERENCE.md
41+
2942
test-install-task-on-ubuntu:
3043
strategy:
3144
matrix:

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,5 @@
33
.rerun.json
44
.resource_types
55
.task_cache.json
6+
.yardoc
67
Puppetfile

Gemfile

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
source 'https://rubygems.org'
2+
3+
group :development do
4+
# For REFERENCE.md generation.
5+
gem 'puppet', '~> 8.0'
6+
gem 'puppet-strings'
7+
end

REFERENCE.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# Reference
2+
3+
<!-- DO NOT EDIT: This document was generated by Puppet Strings -->
4+
5+
## Table of Contents
6+
7+
### Tasks
8+
9+
* [`install`](#install): Installs the openvox-agent package.
10+
* [`install_build_artifact`](#install_build_artifact): Downloads and installs a package directly from openvox build artifact server. This can be used to help with testing builds prior to release.
11+
12+
## Tasks
13+
14+
### <a name="install"></a>`install`
15+
16+
Installs the openvox-agent package.
17+
18+
**Supports noop?** false
19+
20+
#### Parameters
21+
22+
##### `version`
23+
24+
Data type: `Optional[String]`
25+
26+
The version of the openvox-agent package to install. Defaults to latest.
27+
28+
##### `collection`
29+
30+
Data type: `Optional[String]`
31+
32+
The openvox collection to install from.
33+
34+
##### `apt_source`
35+
36+
Data type: `Optional[String]`
37+
38+
The apt source repository to retrieve deb packages from.
39+
40+
##### `yum_source`
41+
42+
Data type: `Optional[String]`
43+
44+
The yum source repository to retrieve rpm packages from.
45+
46+
### <a name="install_build_artifact"></a>`install_build_artifact`
47+
48+
Downloads and installs a package directly from openvox build artifact server. This can be used to help with testing builds prior to release. (To install a released version, use the openvox_bootstrap::install task.)
49+
50+
**Supports noop?** false
51+
52+
#### Parameters
53+
54+
##### `version`
55+
56+
Data type: `String[1]`
57+
58+
The version of the package to install.
59+
60+
##### `package`
61+
62+
Data type: `String[1]`
63+
64+
The name of the package to install.
65+
66+
##### `artifacts_source`
67+
68+
Data type: `String[1]`
69+
70+
URL to the build artifacts server.
71+

0 commit comments

Comments
 (0)