(MAINT) Add CI workflow #310

chelnak · 2022-09-26T09:22:12Z

Prior to this commit puppet-strings relied on travis for ci. We have since moved away from travis and use GitHub actions.

This commit creates a new ci.yml workflow that runs on:

A nightly cron
pull request to main
workflow_dispatch

We also remove the legacy travis workflow.

In addition to the above there are also a number of rubocop fixes in this PR. These fixes were required to ensure that spec and linting tests were green.

Prior to this commit puppet-strings relied on travis for ci. We have since moved away from travis and use github actions. This commit creates a new ci.yml workflow that runs on: * A nightly cron * pull request to main * workflow_dispatch

This commit removes the legacy travis workflow from this repository

Prior to this commit Rubocop was constrained to an older version. This was causing cop errors when executed with newer rubies. This commit removes the version constraint from the Gemfile and bumps the target ruby version in rubocops config to 2.5 which is the current minimum supported version.

Prior to this commit the rubocop config in this repository differed from configs used across the modules ecosystem. This commit attempts to align the config and versions used.

danielparks · 2022-09-28T10:43:50Z

lib/puppet/face/strings.rb

-    raise RuntimeError, 'This face requires Ruby 1.9 or greater.' if RUBY_VERSION.match?(/^1\.8/)
+    raise "The 'yard' gem must be installed in order to use this face." unless Puppet.features.yard?
+    raise "The 'rgen' gem must be installed in order to use this face." unless Puppet.features.rgen?
+    raise 'This face requires Ruby 1.9 or greater.' if RUBY_VERSION.match?(%r{^1\.8})


The funny thing here is that .match? didn’t exist until Ruby 2.4.6.

hmm yes.. and to be honest given the minimum ruby for this gem is now 2.5x i wonder if these constraints could be removed?

david22swan

A third of the way through so far, some small thoughts

lib/puppet-strings/describe.rb

lib/puppet-strings/yard/code_objects/class.rb

lib/puppet-strings/yard/code_objects/data_type.rb

lib/puppet-strings/yard/code_objects/data_type_alias.rb

lib/puppet-strings/yard/code_objects/defined_type.rb

lib/puppet-strings/yard/code_objects/function.rb

lib/puppet-strings/yard/code_objects/plan.rb

lib/puppet-strings/yard/code_objects/provider.rb

lib/puppet-strings/yard/code_objects/task.rb

lib/puppet-strings/yard/code_objects/type.rb

chelnak · 2022-09-28T12:31:01Z

@david22swan With regards to the _prefix parameter.

It looks like it is a requirement brought forward by inheritance.

The base class for our CodeObjects classes inherit from YARD::CodeObjects::NamespaceObject. This has an instance method called name that expects a parameter (prefix).

Given that our classes seem to build on the OO nature of YARD i'd be hesitant to remove it because we do not know whether other methods will be expecting an object with a signature of my_object.name(prefix).

I think what can be misleading here is using false as a default. I've seen others use more descriptive symbols in these cases. We could adopt this change here?

There is however documentation for the param on most of these methods that states it's intention:

# @param [Boolean] prefix whether to show a prefix. Ignored for Puppet group namespaces.

There may be more value ensuring that this message is constant across all of the CodeObjects classes.

What do you think?

david22swan · 2022-09-28T12:33:37Z

Sounds good to me

danielparks · 2022-09-29T09:00:37Z

lib/puppet-strings/yard.rb

@@ -114,18 +114,18 @@ def output(name, data, undoc = nil)
    @undocumented += undoc if undoc.is_a?(Integer)
    data =
      if undoc
-        ('%5s (% 5d undocumented)' % [data, undoc])
+        "#{data} (#{undoc} undocumented)"


This is what the new output will look like if there is more than 9 of some type (assuming I didn’t read this wrong):

Files: 1 Modules: 0 (0 undocumented) Classes: 0 (0 undocumented) Constants: 0 (0 undocumented) Attributes: 0 (0 undocumented) Methods: 0 (0 undocumented) Puppet Classes: 10 (0 undocumented) Puppet Data Types: 0 (0 undocumented) Puppet Data Type Aliases: 10 (10 undocumented) Puppet Defined Types: 1 (0 undocumented) Puppet Types: 0 (0 undocumented) Puppet Functions: 0 (0 undocumented) Puppet Providers: 0 (0 undocumented) Puppet Plans: 0 (0 undocumented) Puppet Tasks: 0 (0 undocumented)

I think that’s fine, especially since I imagine the vast majority of modules have fewer than <10 of anything. Just wanted to make it explicit.

pmcmaw

Thanks for this @chelnak
These changes are well overdue! 👍

pmcmaw · 2022-09-29T09:02:05Z

Merging as the outstanding status is for Travis CI which has been removed.

chelnak added the maintenance label Sep 26, 2022

chelnak self-assigned this Sep 26, 2022

chelnak requested a review from a team as a code owner September 26, 2022 09:22

chelnak force-pushed the maint-add_ci_workflow branch 5 times, most recently from fcddc6d to ec68c99 Compare September 26, 2022 09:49

chelnak added 3 commits September 26, 2022 11:55

(MAINT) Add CI workflow

a95a22f

Prior to this commit puppet-strings relied on travis for ci. We have since moved away from travis and use github actions. This commit creates a new ci.yml workflow that runs on: * A nightly cron * pull request to main * workflow_dispatch

(MAINT) Remove travis

491b72f

This commit removes the legacy travis workflow from this repository

chelnak force-pushed the maint-add_ci_workflow branch from d9d68e5 to 294c627 Compare September 26, 2022 10:58

chelnak mentioned this pull request Sep 26, 2022

Minimum Ruby version is incompatible with current code #301

Closed

chelnak force-pushed the maint-add_ci_workflow branch from 06abf37 to 08d63d3 Compare September 27, 2022 11:58

danielparks mentioned this pull request Sep 28, 2022

(#267) Don’t show “Public X” header without contents #314

Merged

chelnak force-pushed the maint-add_ci_workflow branch from 08d63d3 to 67795af Compare September 28, 2022 08:27

(MAINT) Standardise rubocop configs

13495b8

Prior to this commit the rubocop config in this repository differed from configs used across the modules ecosystem. This commit attempts to align the config and versions used.

chelnak force-pushed the maint-add_ci_workflow branch 5 times, most recently from 1955993 to c0bd743 Compare September 28, 2022 09:55

chelnak added 7 commits September 28, 2022 10:57

(MAINT) Rubocop - (spec) fixes for acceptance

a613e69

(MAINT) Rubocop - (spec) fixes for yard

b11a02c

(MAINT) Rubocop - (spec) fixes for puppet-strings

5ceb042

(MAINT) Rubocop - (spec) fixes for spec helpers

d5a3fb3

(MAINT) Rubocop - (spec) improve output capture

d2e9937

(MAINT) Rubocop - (lib) fixes for features

5b932b6

(MAINT) Rubocop - (lib) fixes for face

5bec15b

chelnak force-pushed the maint-add_ci_workflow branch from c0bd743 to 1bf8ef5 Compare September 28, 2022 09:57

chelnak force-pushed the maint-add_ci_workflow branch from 1bf8ef5 to cd4efbd Compare September 28, 2022 10:31

danielparks reviewed Sep 28, 2022

View reviewed changes

david22swan reviewed Sep 28, 2022

View reviewed changes

chelnak force-pushed the maint-add_ci_workflow branch from cd4efbd to ea5b786 Compare September 28, 2022 12:33

chelnak added 4 commits September 28, 2022 13:37

(MAINT) Rubocop - (lib) fixes for yard

5af8db8

(MAINT) Rubocop - (lib) fixes for tasks

223ef05

(MAINT) Rubocop - (lib) fixes for monkey_patches

28ace22

(MAINT) Rubocop - (lib) fixes for markdown

e45c4d6

chelnak force-pushed the maint-add_ci_workflow branch 2 times, most recently from 195e88d to ab3e011 Compare September 28, 2022 15:31

(MAINT) Rubocop - (lib) fixes for puppet-strings

f68b2be

chelnak force-pushed the maint-add_ci_workflow branch from ab3e011 to f68b2be Compare September 28, 2022 15:34

danielparks reviewed Sep 29, 2022

View reviewed changes

pmcmaw approved these changes Sep 29, 2022

View reviewed changes

pmcmaw merged commit e7e4444 into main Sep 29, 2022

pmcmaw deleted the maint-add_ci_workflow branch September 29, 2022 09:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

(MAINT) Add CI workflow #310

(MAINT) Add CI workflow #310

Uh oh!

chelnak commented Sep 26, 2022 •

edited

Loading

Uh oh!

danielparks Sep 28, 2022

Uh oh!

chelnak Sep 28, 2022

Uh oh!

david22swan left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

chelnak commented Sep 28, 2022

Uh oh!

david22swan commented Sep 28, 2022

Uh oh!

danielparks Sep 29, 2022

Uh oh!

pmcmaw left a comment

Uh oh!

pmcmaw commented Sep 29, 2022

Uh oh!

Uh oh!

(MAINT) Add CI workflow #310

(MAINT) Add CI workflow #310

Uh oh!

Conversation

chelnak commented Sep 26, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

danielparks Sep 28, 2022

Choose a reason for hiding this comment

Uh oh!

chelnak Sep 28, 2022

Choose a reason for hiding this comment

Uh oh!

david22swan left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

chelnak commented Sep 28, 2022

Uh oh!

david22swan commented Sep 28, 2022

Uh oh!

danielparks Sep 29, 2022

Choose a reason for hiding this comment

Uh oh!

pmcmaw left a comment

Choose a reason for hiding this comment

Uh oh!

pmcmaw commented Sep 29, 2022

Uh oh!

Uh oh!

chelnak commented Sep 26, 2022 •

edited

Loading