Git Product home page Git Product logo

puppet-pre-commit-hooks's Introduction

Puppet pre-commit hooks

pre-commit hooks for use on Puppet projects.

Provides the following hooks:

  • puppet-validate: uses puppet parser validate to check the syntax of Puppet manifests.

  • puppet-lint: uses puppet-lint to check for stylistic issues with your Puppet manifests.

  • erb-validate: compiles and syntax-checks Ruby erb templates.

  • epp-validate: validates and syntax-checks Puppet's epp templates.

Usage

  1. Install pre-commit, if you haven't already.

  2. Add the following lines to a file named .pre-commit-config.yaml in the root of your git repository:

    -   repo: https://github.com/chriskuehl/puppet-pre-commit-hooks.git
        sha: v2.0.1
        hooks:
        -   id: puppet-validate
        -   id: erb-validate
        -   id: epp-validate
        -   id: puppet-lint
            args:
            -   --fail-on-warnings

    You'll almost certainly want to adjust the puppet-lint args for your project. I find the following most helpful:

            -   --no-80chars-check
            -   --no-documentation-check
            -   --no-puppet_url_without_modules-check
  3. Run pre-commit install to add pre-commit git hooks.

  4. Test the hooks work properly with pre-commit run --all-files.

Any other arguments to puppet-validate will be fed directly to puppet parser validate, as long as they are in the format --arg=value.

By default, the latest versions of puppet and puppet-lint are used. If you'd like to use a different version, you can pass additional_dependencies when definining the hooks.

For example, if you're still using Puppet 3, you can use:

hooks:
-   id: puppet-validate
    additional_dependencies: ['puppet:<4']

To see what dependencies you might want to change, take a look at hooks.yaml in this repo.

puppet-pre-commit-hooks's People

Contributors

chriskuehl avatar alexjurkiewicz avatar jvperrin avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.