puppetlabs / puppetlabs/puppetlabs-stdlib

stdlib fails stdlib_deprecation check due to "bad" example file

Open
#1,441 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Ruby
Stars
349
Forks
573
Avg merge
3d 3h
Merged PRs (30d)
1

Description

We've been running the stdlib_deprecations linter across all of our puppet code and were surprised to find that stdlib (version 9.6.0) itself has some deprecated functions defined ! Fortunately its not in actual code - but in one of the example files, see below. It would be good to get this example file cleaned up.

stdlib/examples/has_interface_with.pp - WARNING: Deprecated function found: 'has_interface_with'. Use stdlib::has_interface_with instead. on line 2 (check: stdlib_deprecated_functions)
stdlib/examples/has_interface_with.pp - WARNING: Deprecated function found: 'has_interface_with'. Use stdlib::has_interface_with instead. on line 3 (check: stdlib_deprecated_functions)
stdlib/examples/has_interface_with.pp - WARNING: Deprecated function found: 'has_interface_with'. Use stdlib::has_interface_with instead. on line 4 (check: stdlib_deprecated_functions)
stdlib/examples/has_interface_with.pp - WARNING: Deprecated function found: 'has_interface_with'. Use stdlib::has_interface_with instead. on line 5 (check: stdlib_deprecated_functions)
stdlib/examples/has_interface_with.pp - WARNING: Deprecated function found: 'has_interface_with'. Use stdlib::has_interface_with instead. on line 6 (check: stdlib_deprecated_functions)
stdlib/examples/has_interface_with.pp - WARNING: Deprecated function found: 'has_interface_with'. Use stdlib::has_interface_with instead. on line 7 (check: stdlib_deprecated_functions)
stdlib/examples/has_interface_with.pp - WARNING: Deprecated function found: 'has_interface_with'. Use stdlib::has_interface_with instead. on line 8 (check: stdlib_deprecated_functions)
stdlib/examples/has_interface_with.pp - WARNING: Deprecated function found: 'has_interface_with'. Use stdlib::has_interface_with instead. on line 9 (check: stdlib_deprecated_functions)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open stdlib/examples/has_interface_with.pp and inspect the deprecated function calls reported on lines 2–9. Replace the calls as indicated by the linter, then run the stdlib_deprecations check across the examples and confirm that this file produces no warnings.

Written by the indexing model from the issue text.

Assessment

Domain
tooling
Issue type
Bug
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.