puppetlabs / puppetlabs/puppet-resource_api
Have a `deprecated` feature flag
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 27
- Forks
- 42
- PR merge metrics
- No merged PRs in 30d
Description
Use Case
When a type&provider is irredeemably obsolete, broken or mis-designed, module authors want to indicate that to the public, and provide advice on better alternatives.
Describe the Solution You Would Like
To ease the pain of deprecating types, add a feature flag deprecated and a new top-level type definition key deprecation_message. When the type is used, the deprecation message is surfaced once through puppet's deprecation log channel.
Describe Alternatives You've Considered
None.
Additional Context
None.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No files, tests, or entry points are named. Start by locating how feature flags, top-level type definition keys, and Puppet's deprecation log channel are handled; done means obsolete types can declare the new flag and message, and usage surfaces that message once.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- api, backend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100