From 23a40aba300ae3877b80adef70a3176e255aff63 Mon Sep 17 00:00:00 2001 From: kevpl Date: Mon, 14 Nov 2016 13:47:00 -0800 Subject: [PATCH] (MAINT) fill README doc & MAINTAINERS [skip ci] --- MAINTAINERS | 38 ++++++++++++++++++++++++++++++++++++++ README.md | 21 +++++++++++++++++++++ 2 files changed, 59 insertions(+) create mode 100644 MAINTAINERS diff --git a/MAINTAINERS b/MAINTAINERS new file mode 100644 index 00000000..93632bf9 --- /dev/null +++ b/MAINTAINERS @@ -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": "ki@puppet.com", + "name": "Kevin Imber" + }, + { + "github": "tvpartytonight", + "email": "tv@puppet.com", + "name": "Tony Vu" + }, + { + "github": "jpartlow", + "email": "joshua.partlow@puppet.com", + "name": "Josh Partlow" + }, + { + "github": "demophoon", + "email": "britt@puppet.com", + "name": "Britt Gresham" + }, + { + "github": "highb", + "email": "brandon.high@puppet.com", + "name": "Brandon High" + }, + { + "github": "ericwilliamson", + "email": "eric.williamson@puppet.com", + "name": "Eric Williamson" + } + ] +} diff --git a/README.md b/README.md index 11330669..7c1fc07a 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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).