Skip to content

Commit

Permalink
(MAINT) fill README doc & MAINTAINERS
Browse files Browse the repository at this point in the history
[skip ci]
  • Loading branch information
kevpl committed Nov 14, 2016
1 parent 24d7899 commit 23a40ab
Show file tree
Hide file tree
Showing 2 changed files with 59 additions and 0 deletions.
38 changes: 38 additions & 0 deletions MAINTAINERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
{
"version": 1,
"file_format": "This MAINTAINERS file format is described at http://pup.pt/maintainers",
"issues": "https://tickets.puppet.com/browse/PE",
"internal_list": "https://groups.google.com/a/puppet.com/forum/?hl=en#!forum/discuss-organizational-scale",
"people": [
{
"github": "kevpl",
"email": "[email protected]",
"name": "Kevin Imber"
},
{
"github": "tvpartytonight",
"email": "[email protected]",
"name": "Tony Vu"
},
{
"github": "jpartlow",
"email": "[email protected]",
"name": "Josh Partlow"
},
{
"github": "demophoon",
"email": "[email protected]",
"name": "Britt Gresham"
},
{
"github": "highb",
"email": "[email protected]",
"name": "Brandon High"
},
{
"github": "ericwilliamson",
"email": "[email protected]",
"name": "Eric Williamson"
}
]
}
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,13 @@ The PE Beaker library contains all PE-specific

that help someone acceptance test PE easier with Beaker.

# Documentation

- [Rubydocs](http://www.rubydoc.info/github/puppetlabs/beaker-pe) contain the
technical reference for APIs and other aspects of beaker-pe. They describe
how it works and how to use it but assume that you have a basic understanding
of key concepts.

# Upgrading from 0.y to 1.y?

If you've used beaker-pe previously (during the 0.y versions), you'll
Expand Down Expand Up @@ -51,3 +58,17 @@ task. It should be noted that this is a shortcut for the `test:acceptance:quick`
task, which is named as such because it uses no pre-suite. This uses a default
provided hosts file for acceptance under the `acceptance/config` directory. If
you'd like to provide your own hosts file, set the `CONFIG` environment variable.

# Release

To release new versions, we use a
[Jenkins job](https://jenkins-qe.delivery.puppetlabs.net/job/qe_beaker-pe_btc-rls/)
(access to internal infrastructure will be required to view job).

To release a new version (from the master branch), you'll need to just provide
a new beaker-pe version number to the job, and you're off to the races.

# Questions

If you have questions, please reach out to our
[MAINTAINERS](MAINTAINERS).

0 comments on commit 23a40ab

Please sign in to comment.