Module: Onceover::CodeQuality::Docs

Defined in:
lib/onceover/codequality/docs.rb

Constant Summary collapse

LOCAL_MOD_DIR = 
"site"

Class Method Summary collapse

Class Method Details

.puppet_strings(html_docs) ⇒ Object 



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/onceover/codequality/docs.rb', line 8

def self.puppet_strings(html_docs)
  logger.info "Generating documentation..."
  status = true
  format = html_docs ? "html" : "markdown"
  if Dir.exist?(LOCAL_MOD_DIR)
    Dir.glob("#{LOCAL_MOD_DIR}/*/") { |dir|
      Dir.chdir(dir) {
        # puppet strings prints useful metrics so don't swallow its output
        s = system("puppet strings generate --format #{format}")
        if ! s
          logger.error("Error running puppet strings - see previous output")
        end
        status &= s
      }
    }
  end

  status
end