Skip to content

Commit a8d4bbd

Browse files
author
Jeff McCune
committed
(maint) Add semantic versioning info to README
This patch adds semantic versioning information to the README of this module. This information is missing and unclear without this patch. This should help clarify the support matrix for the Standard Library as it relates to Puppet Enterprise released versions.
1 parent bdba42d commit a8d4bbd

File tree

1 file changed

+26
-4
lines changed

1 file changed

+26
-4
lines changed

README.markdown

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,34 @@ This module is officially curated and provided by Puppet Labs. The modules
1414
Puppet Labs writes and distributes will make heavy use of this standard
1515
library.
1616

17+
# Versions #
18+
19+
This module follows semver.org (v1.0.0) versioning guidelines. The standard
20+
library module is released as part of [Puppet
21+
Enterprise](http://puppetlabs.com/puppet/puppet-enterprise/) and as a result
22+
older versions of Puppet Enterprise that Puppet Labs still supports will have
23+
bugfix maintenance branches periodically "merged up" into master. The current
24+
list of integration branches are:
25+
26+
* v2.1.x (v2.1.1 released in PE 1.2, 1.2.1, 1.2.3, 1.2.4)
27+
* v2.2.x (Never released as part of PE, only to the Forge)
28+
* v2.3.x (Scheduled for next PE feature release)
29+
* master (mainline development branch)
30+
31+
The first Puppet Enterprise version including the stdlib module is Puppet
32+
Enterprise 1.2.
33+
1734
# Compatibility #
1835

19-
This module is designed to work with Puppet version 2.6 and later. It may be
20-
forked if Puppet 2.7 specific features are added. There are currently no plans
21-
for a Puppet 0.25 standard library module.
36+
## stdlib v2.1.x, v2.2.x ##
37+
38+
v2.1.x and v2.2.x of this module are designed to work with Puppet versions
39+
2.6.x and 2.7.x. There are currently no plans for a Puppet 0.25 standard
40+
library module.
41+
42+
## stdlib v2.3.x ##
43+
44+
While not yet released, the standard library may only work with Puppet 2.7.x.
2245

2346
# Functions #
2447

@@ -57,4 +80,3 @@ automatically. This is a direct copy of R.I. Pienaar's custom facter fact
5780
located at:
5881
[https://github.com/ripienaar/facter-facts/tree/master/facts-dot-d](https://github.com/ripienaar/facter-facts/tree/master/facts-dot-d)
5982

60-

0 commit comments

Comments
 (0)