Skip to content

(CAT-1434) Update README #156

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Oct 2, 2023
Merged

(CAT-1434) Update README #156

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,7 @@ guide](http://puppet.com/docs/puppet/latest/style_guide.html). Puppet Lint valid

## Compatibility warning
Copy link

Choose a reason for hiding this comment

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

This is useful information. Please keep it in. Perhaps update it to make it clear it is current.


Version 3.0.0 and above will no longer support Puppet 6 environments.

In cases where Puppet Lint is required in an environment with Puppet 6, we recommend pinning to version 2.5.2.
This tool is only supported on Puppet 7 & 8 environments. In cases where Puppet Lint is required in an environment with Puppet 6, we recommend pinning to version 2.5.2.

## Installation

Expand Down Expand Up @@ -297,6 +295,18 @@ If you find a bug in Puppet Lint or its results, please create an issue in the
[repo issues tracker](https://github.com/puppetlabs/puppet-lint/issues/). Bonus
points will be awarded if you also include a patch that fixes the issue.

## Development

Acceptance tests for this tool leverage [puppet_litmus](https://github.com/puppetlabs/puppet_litmus).
Copy link

Choose a reason for hiding this comment

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

I really wish it didn't. Litmus an aweful tool for this and I wish #89 got a proper response for maintainers.

Copy link
Author

Choose a reason for hiding this comment

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

Hi @ekohl. I'll make a note of this and bring it to the team for discussion

To run the acceptance tests follow the instructions [here](https://github.com/puppetlabs/puppet_litmus/wiki/Tutorial:-use-Litmus-to-execute-acceptance-tests-with-a-sample-module-(MoTD)#install-the-necessary-gems-for-the-module).
You can also find a tutorial and walkthrough of using Litmus and the PDK on [YouTube](https://www.youtube.com/watch?v=FYfR7ZEGHoE).

If you run into an issue with this tool or would like to request a feature you can [raise a PR](https://github.com/puppetlabs/puppet-lint/pulls) with your suggested changes. Alternatively, you can [raise a Github issue](https://github.com/puppetlabs/puppet-lint/issues) with a feature request or to report any bugs.
Every other Tuesday the DevX team holds [office hours](https://puppet.com/community/office-hours) in the [Puppet Community Slack](http://slack.puppet.com/), where you can ask questions about this and any other supported tools.
This session runs at 15:00 (GMT) for about an hour.

If you have problems getting this tool up and running, please [contact Support](http://puppetlabs.com/services/customer-support).

## Thank you

Many thanks to the following people for contributing to puppet-lint
Expand Down