Skip to content

Commit

Permalink
Merge pull request #4 from dhoppe/readme
Browse files Browse the repository at this point in the history
Add missing badges
  • Loading branch information
bastelfreak committed Nov 2, 2016
2 parents d46479d + c4c7431 commit 698a1ec
Show file tree
Hide file tree
Showing 6 changed files with 69 additions and 47 deletions.
2 changes: 2 additions & 0 deletions .sync.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
.travis.yml:
secure: "RrAmWtM6eTjZZzD954AIgR179Pqp14lzHhd/C9cpKbTPynLncuim08CEvjmq+7pgAy9XDg1d02x3udfZt4btR1sBdyNRpNN3yUhWptmGU61HRJdiZq+nSLQkIYsqXanhk+O3NndFojO58WRD01dkWEc6HRHjlivuYNxDXmMkg9k="
#spec/spec_helper_acceptance.rb:
# Temporarily unmanage spec_helper_acceptance (iss. #133)
# windows: true
Expand Down
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ deploy:
branch: ha-bug-puppet-forge
user: puppet
password:
secure: ""
secure: "RrAmWtM6eTjZZzD954AIgR179Pqp14lzHhd/C9cpKbTPynLncuim08CEvjmq+7pgAy9XDg1d02x3udfZt4btR1sBdyNRpNN3yUhWptmGU61HRJdiZq+nSLQkIYsqXanhk+O3NndFojO58WRD01dkWEc6HRHjlivuYNxDXmMkg9k="
on:
tags: true
# all_branches is required to use tags
Expand Down
88 changes: 54 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,43 @@
# puppet-visualstudio
# Visual Studio module for Puppet

####Table of Contents
[![Build Status](https://travis-ci.org/voxpupuli/puppet-visualstudio.png?branch=master)](https://travis-ci.org/voxpupuli/puppet-visualstudio)
[![Code Coverage](https://coveralls.io/repos/github/voxpupuli/puppet-visualstudio/badge.svg?branch=master)](https://coveralls.io/github/voxpupuli/puppet-visualstudio)
[![Puppet Forge](https://img.shields.io/puppetforge/v/puppet/visualstudio.svg)](https://forge.puppetlabs.com/puppet/visualstudio)
[![Puppet Forge - downloads](https://img.shields.io/puppetforge/dt/puppet/visualstudio.svg)](https://forge.puppetlabs.com/puppet/visualstudio)
[![Puppet Forge - endorsement](https://img.shields.io/puppetforge/e/puppet/visualstudio.svg)](https://forge.puppetlabs.com/puppet/visualstudio)
[![Puppet Forge - scores](https://img.shields.io/puppetforge/f/puppet/visualstudio.svg)](https://forge.puppetlabs.com/puppet/visualstudio)

#### Table of Contents

1. [Overview](#overview)
2. [Module Description - What is the visualstudio module?](#module-description)
3. [Setup - The basics of getting started with visualstudio](#setup)
1. [Module Description - What is the visualstudio module?](#module-description)
1. [Setup - The basics of getting started with visualstudio](#setup)
* [What visualstudio affects](#what-visualstudio-affects)
* [Setup requirements](#setup-requirements)
* [Beginning with visualstudio](#beginning-with-visualstudio)
4. [Usage - Configuration options and additional functionality](#usage)
5. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
5. [Limitations - OS compatibility, etc.](#limitations)
6. [Development - Guide for contributing to the module](#development)
1. [Usage - Configuration options and additional functionality](#usage)
1. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
1. [Limitations - OS compatibility, etc.](#limitations)
1. [Development - Guide for contributing to the module](#development)

##Overview
## Overview

Puppet module for managing [Microsoft Visual Studio](http://www.visualstudio.com/)

[![Build Status](https://secure.travis-ci.org/liamjbennett/puppet-visualstudio.png)](http://travis-ci.org/liamjbennett/puppet-visualstudio)

##Module Description
## Module Description

The purpose of this module is to install the Microsoft Visual Studio suite and configure it's many service packs, tools, utilities and registry options.
The purpose of this module is to install the Microsoft Visual Studio suite and
configure it's many service packs, tools, utilities and registry options.

##Setup
## Setup

###What autoupdates affects
### What autoupdates affects

* Installs packages
* Alters registry keys

###Beginning with autoupdate
### Beginning with autoupdate

Installing Visual Studio 2012:

Expand All @@ -43,40 +50,53 @@ Installing Visual Studio 2012:
}
```

##Usage
## Usage

### Classes and Defined Types

###Classes and Defined Types
#### Defined Type: `visualstudio`

####Defined Type: `visualstudio`
The primary definition of this module, it installs and configures the visual studio application on the system
The primary definition of this module, it installs and configures the visual
studio application on the system

**Parameters within `visualstudio`:**
#####`ensure`

##### `ensure`

Ensure that the application is installed or not.

#####`version`
##### `version`

The version of visual studio that should be installed

#####`edition`
##### `edition`

The edition of visual studio that should be installed

#####`license_key`
The license key that corresponds to the version and edition that you have specified. This is required for installation to be successful.
##### `license_key`

The license key that corresponds to the version and edition that you have
specified. This is required for installation to be successful.

##### `components`

#####`components`
The list components, tools and utilities that can be installed as part of the visual studio installation.
The list components, tools and utilities that can be installed as part of the
visual studio installation.

##### `deployment_root`

#####`deployment_root`
Network location where the visual studio packages are located

##Reference
## Reference

### Defined Types

###Defined Types
####Public Defined Types
* [`visualstudio`](#class_visualstudio): Guides the basic installation and configuration of visual studio
#### Public Defined Types

* [`visualstudio`](#class_visualstudio): Guides the basic installation and
configuration of visual studio

##Limitations
## Limitations

This module is tested on the following platforms:

Expand All @@ -88,8 +108,8 @@ It support the following Visual Studio versions:

* 2012

##Development
## Development

###Contributing
### Contributing

Please read CONTRIBUTING.md for full details on contributing to this project.
12 changes: 6 additions & 6 deletions spec/defines/visualstudio/package_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

it do
expect do
should contain_visualstudio__package('visual studio 2012')
is_expected.to contain_visualstudio__package('visual studio 2012')
end.to raise_error
end
end
Expand All @@ -33,7 +33,7 @@

it do
expect do
should contain_visualstudio__package("visual studio #{version}")
is_expected.to contain_visualstudio__package("visual studio #{version}")
end.to raise_error
end
end
Expand All @@ -52,7 +52,7 @@

it do
expect do
should contain_visualstudio__package('visual studio 2012')
is_expected.to contain_visualstudio__package('visual studio 2012')
end.to raise_error
end
end
Expand All @@ -71,7 +71,7 @@

it do
expect do
should contain_visualstudio__package('visual studio 2012')
is_expected.to contain_visualstudio__package('visual studio 2012')
end.to raise_error
end
end
Expand All @@ -89,7 +89,7 @@
end

it do
should contain_exec('install-visualstudio').with(
is_expected.to contain_exec('install-visualstudio').with(
'command' => "& \"\\test-server\\packages\\VS2012\\#{edition}\\vs_#{edition}.exe\" /adminfile \"C:\\Windows\\Temp\\visualstudio_config.xml\" /quiet /norestart",
'provider' => 'powershell'
)
Expand All @@ -111,7 +111,7 @@
end

it do
should contain_exec('uninstall-visualstudio').with(
is_expected.to contain_exec('uninstall-visualstudio').with(
'command' => "& \"\\test-server\\packages\\VS2012\\#{edition}\\vs_#{edition}.exe\" /uninstall /quiet /norestart",
'provider' => 'powershell'
)
Expand Down
2 changes: 1 addition & 1 deletion spec/defines/visualstudio/params_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@
}
end

it { should have_resource_count(0) }
it { is_expected.to have_resource_count(0) }
end
10 changes: 5 additions & 5 deletions spec/defines/visualstudio/visualstudio_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

it do
expect do
should contain_visualstudio__package('visual studio 2012')
is_expected.to contain_visualstudio__package('visual studio 2012')
end.to raise_error(Puppet::Error, %r{The version argument specified does not match a supported version of visual studio})
end
end
Expand All @@ -33,7 +33,7 @@

it do
expect do
should contain_visualstudio__package("visual studio #{version}")
is_expected.to contain_visualstudio__package("visual studio #{version}")
end.to raise_error(Puppet::Error, %r{The edition argument does not match a valid edition for the specified version of visual studio})
end
end
Expand All @@ -52,7 +52,7 @@

it do
expect do
should contain_visualstudio__package('visual studio 2012')
is_expected.to contain_visualstudio__package('visual studio 2012')
end.to raise_error(Puppet::Error, %r{The license_key argument speicifed is not correctly formatted})
end
end
Expand All @@ -71,7 +71,7 @@

it do
expect do
should contain_visualstudio__package('visual studio 2012')
is_expected.to contain_visualstudio__package('visual studio 2012')
end.to raise_error(Puppet::Error, %r{The ensure argument does not match present or absent})
end
end
Expand All @@ -88,7 +88,7 @@
}
end

it { should contain_visualstudio__package("visual studio #{version}") }
it { is_expected.to contain_visualstudio__package("visual studio #{version}") }
end
end
end

0 comments on commit 698a1ec

Please sign in to comment.