Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Harden codebase and add documentation stubs #974

Merged
merged 2 commits into from
Mar 29, 2024
Merged

Harden codebase and add documentation stubs #974

merged 2 commits into from
Mar 29, 2024

Conversation

zilchms
Copy link
Contributor

@zilchms zilchms commented Mar 29, 2024

Might be backwards incompatible due to codebase hardening. Hardening occurs in:

  • repo::apt
  • repo::rhel
  • service
    All of those are either changing String to String[1] (disallowing empty Strings) or add a String datatype to variables already having a default String value

@zilchms zilchms added the docs Improvements or additions to documentation label Mar 29, 2024
Copy link
Contributor

@wyardley wyardley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @zilchms
Can you clarify what is being hardened and what the likely breaking changes might be? Are they related to features not available in certain Puppet versions, or something else?

@wyardley wyardley added the enhancement New feature or request label Mar 29, 2024
@wyardley
Copy link
Contributor

Also, I'm thinking this should probably be flagged as an enhancement as well as a docs change?

@zilchms
Copy link
Contributor Author

zilchms commented Mar 29, 2024

Sure let me edit the description real quick :)

Copy link
Contributor

@wyardley wyardley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🙏

Not sure if this will cause big conflicts with #926 -- @kajinamit - you may have to make some adjustments when you rebase.

@wyardley wyardley merged commit c4785ff into master Mar 29, 2024
6 checks passed
@wyardley wyardley deleted the docs branch March 29, 2024 17:06
@wyardley
Copy link
Contributor

I'm going to leave off the "backwards incompatible" label, since I don't think this should interfere with normal / expected use of the module; let me know if that's untrue, though.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants