Code Monkey home page Code Monkey logo

puppet5-blank's Introduction

puppet5-blank

experimental License

Build Status Coverage Status Dependency Status

Puppet Forge Version Puppet Forge Downloads Puppet Forge Endorsement

Introduction

A blank module for Puppet 5.x

This module currently installs and configures the following software and services:

  • nothing

Classes

blank

This is a blank class that does nothing

Parameters

[String] example

This is an example parameter entry

Hiera

Puppet 5.x allows the use of an in-module data store in the data directory. Internal package variables can be set there without exposing them as paramters. These can be over-ridden in the Hiera data store on the host, on a Puppet server, or in a Puppet environment.

Attributions

puppet5-blank

This module was based on puppet5-blank, a Puppet 5.x module template created by Aethylred

Blank

This module uses the skeleton puppet5-blank, a Puppet 5.x module template created by Aethylred. Usage is simple, follow the Unblank checklist in the [To Do](#To Do) list, which pretty much consists of replacing Author with your name and blank with your module name.

The puppet5-blank template includes configuration for:

  • Example class blank::oscheck for checking Puppet module OS compatibility
  • Travis-CI
    • rspec-puppet
      • Configured with .rspec file
    • rspec-puppet-facts to provide a all OS facts for testing
    • Spec tests
    • Code checks
      • Puppet syntax check
      • Puppet style checks using puppet-lint
      • Puppet module metadata checks using metadata-json-lint
      • Ruby syntax check
      • validate YAML
        • Check hiera.yaml
        • Check travis.yml
        • Check hiera\ directory
      • Check for Windows line endings (because Aethylred uses Windows for $work)
  • Git configuration
    • Set up .gitignore for Puppet module development
    • Set up .gitattributes for Puppet module development
      • Line endings rules
      • Linguist definitions for GitHub/GitLab programming language analysis
  • Gemnasium to check Ruby Gem health
  • Coveralls to report testing coverage
  • Beaker acceptance testing (Work in Progress)
  • Sample README.md
  • Starting CHANGELOG.md
  • Includes Apache 2.0 License
  • Badges!

To Do

The following things are still to be done:

Unblank

  • Edit metadata.json
  • Edit .fixtures
  • Edit manifests/init.pp
  • Edit manifests/oscheck.pp
  • Edit and rename spec/classes/blank_spec.rb
  • Edit and rename spec/classes/blank_oscheck_spec.rb
  • Edit README.md. Please leave the Attributions for puppet5-blank, otherwise rework it as best suits your project.
  • DO THESE LAST
    • Delete .git
    • Reinitialise the project with git init
    • Do an initial commit
    • Tag as version 0.1.0
    • Set a remote repository
    • Push to a git repository
    • Congratulations, you just shipped a module that does nothing, but has a syntax check, lint check, and test environment.

Get Started

  • Add a Code of Conduct
  • Add a CONTRIBUTING.md contribution guide
  • Fix badges in README.md
    • Fix URI in Travis-CI badge
    • Fix URI in Coveralls badge
    • Fix Puppetforge URIs in Puppetforge badges
  • Write code
  • Commit changes
  • Push to a repository

puppet5-blank's People

Contributors

aethylred avatar

Watchers

 avatar James Cloos 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.