puppet-resource_api 1.8.7 → 1.8.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 299669b16a4103618de3538d5dccb47b1e09cc4e0f3421790b5c4c2eb0f5c9fa
-  data.tar.gz: e34c4aa7b376c6a20c8df7a8355365aba0f3a5c89a44f65fb4755e6b0cbfe9d9
+  metadata.gz: d14e2bf3972db6032efa89ba6051d141c97f0e68a8977f6f667650051a06bdf4
+  data.tar.gz: 4a1609c8cf63542580ad8145ccaa971991b354266496b8f1067a91bf141b66af
 SHA512:
-  metadata.gz: b7bd6c3defae8a1e1cabd4030e31c7eb0565ffa52dbd4d1df38f736984ccab55ae908e3e225f77e4c4979e2d2b1a310eb04ddfc6446140cf5bbf83ebd52c1259
-  data.tar.gz: ea9d3a3645132f360b60769538e181c7e08f56604d37405ecce9c8bdea2bffc198f8c6ad62a2203839ec665ed1aac1e123127efdfdb965f9dbd3e9c17a7fa86f
+  metadata.gz: 88e11a56b4494310be4e5912f9e48f0cb845bcc693f8e16888704db464e3e989c051afe2aece82ec393b3b1237eed002606a8c1600f396b42a54294669e14447
+  data.tar.gz: cf6597f4ef293e46ae1791b693a344dc7e7624cec153a86983c6199db311280a706a5b3efae2aa30739e2631e107ff44d3ba493ca6226f24246ae1e1f7a086b8

data/CHANGELOG.md

@@ -3,8 +3,24 @@
 All significant changes to this repo will be summarized in this file.
 
 
-## [v1.8.6](https://github.com/puppetlabs/puppet-resource_api/tree/v1.8.6) (2019-07-01)
-[Full Changelog](https://github.com/puppetlabs/puppet-resource_api/compare/1.8.5...v1.8.6)
+## [1.8.7](https://github.com/puppetlabs/puppet-resource_api/tree/1.8.7) (2019-09-11)
+[Full Changelog](https://github.com/puppetlabs/puppet-resource_api/compare/1.8.6...1.8.7)
+
+**Fixed bugs:**
+
+- \(FM-8092\) Fix caching scope of transport schemas [\#200](https://github.com/puppetlabs/puppet-resource_api/pull/200) ([DavidS](https://github.com/DavidS))
+
+**Merged pull requests:**
+
+- \(FM-8485\) - Addition of CODEOWNERS file [\#203](https://github.com/puppetlabs/puppet-resource_api/pull/203) ([david22swan](https://github.com/david22swan))
+- \(MODULES-9258\) Improve referencing and add summary [\#199](https://github.com/puppetlabs/puppet-resource_api/pull/199) ([MaxMagill](https://github.com/MaxMagill))
+- \(maint\) Pin both Jruby cells to use `dist: trusty` [\#197](https://github.com/puppetlabs/puppet-resource_api/pull/197) ([da-ar](https://github.com/da-ar))
+
+## [1.8.6](https://github.com/puppetlabs/puppet-resource_api/tree/1.8.6) (2019-07-04)
+[Full Changelog](https://github.com/puppetlabs/puppet-resource_api/compare/1.6.5...1.8.6)
+
+## [1.6.5](https://github.com/puppetlabs/puppet-resource_api/tree/1.6.5) (2019-07-04)
+[Full Changelog](https://github.com/puppetlabs/puppet-resource_api/compare/1.8.5...1.6.5)
 
 **Implemented enhancements:**
 
@@ -16,10 +32,12 @@ All significant changes to this repo will be summarized in this file.
 
 **Merged pull requests:**
 
+- \(packaging\) Bump to 1.6.5 [\#196](https://github.com/puppetlabs/puppet-resource_api/pull/196) ([gimmyxd](https://github.com/gimmyxd))
 - Merge 1.6.x [\#194](https://github.com/puppetlabs/puppet-resource_api/pull/194) ([da-ar](https://github.com/da-ar))
 - \(maint\) test fixes [\#193](https://github.com/puppetlabs/puppet-resource_api/pull/193) ([DavidS](https://github.com/DavidS))
 - \(packaging\) Revert to version '1.8.5' \[no-promote\] [\#192](https://github.com/puppetlabs/puppet-resource_api/pull/192) ([gimmyxd](https://github.com/gimmyxd))
 - \(packaging\) Bump to version '1.9.0' \[no-promote\] [\#191](https://github.com/puppetlabs/puppet-resource_api/pull/191) ([gimmyxd](https://github.com/gimmyxd))
+- \(maint\) retrofitting changelog for the last couple of releases [\#190](https://github.com/puppetlabs/puppet-resource_api/pull/190) ([DavidS](https://github.com/DavidS))
 
 ## [1.8.5](https://github.com/puppetlabs/puppet-resource_api/tree/1.8.5) (2019-06-24)
 [Full Changelog](https://github.com/puppetlabs/puppet-resource_api/compare/1.8.4...1.8.5)
@@ -34,7 +52,6 @@ All significant changes to this repo will be summarized in this file.
 - \(FM-8265\) Merge branch '1.6.x' into master [\#188](https://github.com/puppetlabs/puppet-resource_api/pull/188) ([da-ar](https://github.com/da-ar))
 - \(maint\) test fixes [\#185](https://github.com/puppetlabs/puppet-resource_api/pull/185) ([DavidS](https://github.com/DavidS))
 - \(maint\) make test order really random [\#175](https://github.com/puppetlabs/puppet-resource_api/pull/175) ([DavidS](https://github.com/DavidS))
-- \(packaging\) Update reported version to 1.8.4 \[no-promote\] [\#171](https://github.com/puppetlabs/puppet-resource_api/pull/171) ([gimmyxd](https://github.com/gimmyxd))
 
 ## [1.8.4](https://github.com/puppetlabs/puppet-resource_api/tree/1.8.4) (2019-06-12)
 [Full Changelog](https://github.com/puppetlabs/puppet-resource_api/compare/1.8.3...1.8.4)
@@ -59,6 +76,7 @@ All significant changes to this repo will be summarized in this file.
 - \(maint\) Merge 1.6.x to master  [\#183](https://github.com/puppetlabs/puppet-resource_api/pull/183) ([mihaibuzgau](https://github.com/mihaibuzgau))
 - \(maint\) Fixup Gemfile for JRuby 1.7 installs [\#173](https://github.com/puppetlabs/puppet-resource_api/pull/173) ([da-ar](https://github.com/da-ar))
 - \(maint\) test cleanups [\#172](https://github.com/puppetlabs/puppet-resource_api/pull/172) ([DavidS](https://github.com/DavidS))
+- \(packaging\) Update reported version to 1.8.4 \[no-promote\] [\#171](https://github.com/puppetlabs/puppet-resource_api/pull/171) ([gimmyxd](https://github.com/gimmyxd))
 
 ## [1.8.3](https://github.com/puppetlabs/puppet-resource_api/tree/1.8.3) (2019-04-12)
 [Full Changelog](https://github.com/puppetlabs/puppet-resource_api/compare/1.8.2...1.8.3)
@@ -81,11 +99,16 @@ All significant changes to this repo will be summarized in this file.
 ## [v1.6.4](https://github.com/puppetlabs/puppet-resource_api/tree/v1.6.4) (2019-03-25)
 [Full Changelog](https://github.com/puppetlabs/puppet-resource_api/compare/v1.8.1...v1.6.4)
 
+**Implemented enhancements:**
+
+- \(PDK-1271\) Allow a transport to be wrapped and used like a device [\#155](https://github.com/puppetlabs/puppet-resource_api/pull/155) ([da-ar](https://github.com/da-ar))
+
 **Merged pull requests:**
 
 - Add `implementations` to reserved bolt keywords [\#165](https://github.com/puppetlabs/puppet-resource_api/pull/165) ([DavidS](https://github.com/DavidS))
 - \(MAINT\) Bump version [\#164](https://github.com/puppetlabs/puppet-resource_api/pull/164) ([sebastian-miclea](https://github.com/sebastian-miclea))
 - Release prep for v1.8.1 [\#163](https://github.com/puppetlabs/puppet-resource_api/pull/163) ([DavidS](https://github.com/DavidS))
+- 1.6.x mergeup [\#162](https://github.com/puppetlabs/puppet-resource_api/pull/162) ([DavidS](https://github.com/DavidS))
 
 # Changelog
 

data/README.md

@@ -1,12 +1,14 @@
 # Puppet::ResourceApi [![TravisCI Build Status](https://travis-ci.org/puppetlabs/puppet-resource_api.svg?branch=master)](https://travis-ci.org/puppetlabs/puppet-resource_api) [![Appveyor Build status](https://ci.appveyor.com/api/projects/status/8o9s1ax0hs8lm5fd/branch/master?svg=true)](https://ci.appveyor.com/project/puppetlabs/puppet-resource-api/branch/master) [![codecov](https://codecov.io/gh/puppetlabs/puppet-resource_api/branch/master/graph/badge.svg)](https://codecov.io/gh/puppetlabs/puppet-resource_api)
 
-This is an implementation of the [Resource API](https://github.com/puppetlabs/puppet-specifications/blob/master/language/resource-api/README.md) specification. Find a working example of a new-style providers in the [Palo Alto Firewall module](https://github.com/puppetlabs/puppetlabs-panos/): 
+This is an implementation of the [Resource API specification](https://github.com/puppetlabs/puppet-specifications/blob/master/language/resource-api/README.md).
+
+Find a working example of a new-style providers in the [Palo Alto Firewall module](https://github.com/puppetlabs/puppetlabs-panos/):
+* [Type](https://github.com/puppetlabs/puppetlabs-panos/blob/master/lib/puppet/type/panos_address.rb)
 * [Base provider](https://github.com/puppetlabs/puppetlabs-panos/blob/master/lib/puppet/provider/panos_provider.rb)
-* [Type](https://github.com/puppetlabs/puppetlabs-panos/blob/master/lib/puppet/type/panos_address.rb) 
-* [Actual provider with validation and xml processing](https://github.com/puppetlabs/puppetlabs-panos/blob/master/lib/puppet/provider/panos_address/panos_address.rb) 
+* [Actual provider with validation and xml processing](https://github.com/puppetlabs/puppetlabs-panos/blob/master/lib/puppet/provider/panos_address/panos_address.rb)
 * [New unit tests](https://github.com/puppetlabs/puppetlabs-panos/blob/master/spec/unit/puppet/provider/panos_provider_spec.rb) for 100% coverage.
 
-## [Find the full Resource API documentation here](https://github.com/puppetlabs/puppet-specifications/blob/master/language/resource-api/README.md) 
+## [Find the full Resource API documentation here](https://puppet.com/docs/puppet/latest/custom_resources.html)
 
 ## Related Documents
 
@@ -18,356 +20,18 @@ This is an implementation of the [Resource API](https://github.com/puppetlabs/pu
 * Read [betterspecs](http://www.betterspecs.org/) for general guidelines on what is considered good specs.
 
 
-
 ## Deployment
 
 The `puppet-resource_api` gem is part of the [Puppet 6 Platform](https://puppet.com/blog/introducing-puppet-6). With older versions of Puppet, you can use the [puppetlabs-resource_api module](https://forge.puppet.com/puppetlabs/resource_api) to install the gem on your servers and agents.
 
-## Getting Started
-
-1. Download the [Puppet Development Kit](https://puppet.com/download-puppet-development-kit) (PDK) appropriate to your operating system and architecture.
-
-2. Create a [new module](https://puppet.com/docs/pdk/latest/pdk_generating_modules.html) with the PDK, or work with an existing PDK-enabled module. To create a new module, run `pdk new module <MODULE_NAME>` from the command line, specifying the name of the module. Respond to the dialog questions.
-
-3. To add the `puppet-resource_api` gem and enable "modern" rspec-style mocking, open the `.sync.yml` file in your editor, and add the following content:
-
-```
-# .sync.yml
----
-Gemfile:
-  optional:
-    ':development':
-      - gem: 'puppet-resource_api'
-spec/spec_helper.rb:
-  mock_with: ':rspec'
-```
-
-4. Apply these changes by running `pdk update`
-
-You will get the following response:
-
-```
-$ pdk update
-pdk (INFO): Updating david-example using the default template, from 1.4.1 to 1.4.1
-
-----------Files to be modified----------
-Gemfile
-spec/spec_helper.rb
-
-----------------------------------------
-
-You can find a report of differences in update_report.txt.
-
-Do you want to continue and make these changes to your module? Yes
-
-------------Update completed------------
-
-2 files modified.
-
-$
-```
-
-5. Create the required files for a new type and provider in the module by running `pdk new provider <provider_name>`
-
-You will get the following response:
-
-```
-$ pdk new provider foo
-pdk (INFO): Creating '.../example/lib/puppet/type/foo.rb' from template.
-pdk (INFO): Creating '.../example/lib/puppet/provider/foo/foo.rb' from template.
-pdk (INFO): Creating '.../example/spec/unit/puppet/provider/foo/foo_spec.rb' from template.
-pdk (INFO): Creating '.../example/spec/unit/puppet/type/foo_spec.rb' from template.
-$
-```
-
-The four generated files are the type, the implementation, and the unit tests. The default template contains an example that demonstrates the basic workings of the Resource API. This allows the unit tests to run immediately after creating the provider, which will look like this:
-
-```
-$ pdk test unit
-[✔] Preparing to run the unit tests.
-[✔] Running unit tests.
-  Evaluated 5 tests in 0.012065973 seconds: 0 failures, 0 pending.
-[✔] Cleaning up after running unit tests.
-$
-```
-
-### Writing the Type
-
-The type contains the shape of your resources. The template provides the necessary `name` and `ensure` attributes. You can modify their description and the name's type to match your resource. Add more attributes as you need.
-
-```ruby
-# lib/puppet/type/foo.rb
-require 'puppet/resource_api'
-
-Puppet::ResourceApi.register_type(
-  name: 'foo',
-  docs: <<-EOS,
-      This type provides Puppet with the capabilities to manage ...
-    EOS
-  attributes: {
-    ensure: {
-      type:    'Enum[present, absent]',
-      desc:    'Whether this apt key should be present or absent on the target system.',
-      default: 'present',
-    },
-    name: {
-      type:      'String',
-      desc:      'The name of the resource you want to manage.',
-      behaviour: :namevar,
-    },
-  },
-)
-```
-
-The following keys are available for defining attributes:
-* `type`: the Puppet 4 data type allowed in this attribute. You can use all [data types](https://puppet.com/docs/puppet/latest/lang_data_abstract.html#parent-types) matching `Scalar` and `Data`.
-* `desc`: a string describing this attribute. This is used in creating the automated API docs with [puppet-strings](https://github.com/puppetlabs/puppet-strings).
-* `default`: a default value used by the runtime environment; when the caller does not specify a value for this attribute.
-* `behaviour`/`behavior`: how the attribute behaves. The current available values include:
-  * `namevar`: marks an attribute as part of the "primary key" or "identity" of the resource. A given set of `namevar` values needs to distinctively identify an instance.
-  * `init_only`: this attribute can only be set during the creation of the resource. Its value will be reported going forward, but trying to change it later leads to an error. For example, the base image for a VM or the UID of a user.
-  * `read_only`: values for this attribute will be returned by `get()`, but `set()` is not able to change them. Values for this should never be specified in a manifest. For example, the checksum of a file, or the MAC address of a network interface.
-  * `parameter`: these attributes influence how the provider behaves, and cannot be read from the target system. For example, the target file on inifile, or the credentials to access an API.
-
-Further information about types can be found in The [Resource API](https://github.com/puppetlabs/puppet-specifications/blob/master/language/resource-api/README.md#resource-definition-type)
-
-### Writing the Provider
-
-The provider is the most important part of your new resource, as it reads and enforces state. Here is the example generated by `pdk new provider`:
-
-```ruby
-require 'puppet/resource_api'
-require 'puppet/resource_api/simple_provider'
-
-# Implementation for the foo type using the Resource API.
-class Puppet::Provider::Foo::Foo < Puppet::ResourceApi::SimpleProvider
-  def get(_context)
-    [
-      {
-        name: 'foo',
-        ensure: 'present',
-      },
-      {
-        name: 'bar',
-        ensure: 'present',
-      },
-    ]
-  end
-
-  def create(context, name, should)
-    context.notice("Creating '#{name}' with #{should.inspect}")
-  end
-
-  def update(context, name, should)
-    context.notice("Updating '#{name}' with #{should.inspect}")
-  end
-
-  def delete(context, name)
-    context.notice("Deleting '#{name}'")
-  end
-end
-```
-
-The optional `initialize` method can be used to set up state that is available throughout the execution of the catalog. This is most often used for establishing a connection, when talking to a service (e.g. when managing a database).
-
-The `get(context)` method returns a list of hashes describing the resources that are currently on the target system. The basic example would always return an empty list. Here is an example of resources that could be returned from this:
-
-```ruby
-[
-  {
-    name: 'a',
-    ensure: 'present',
-  },
-  {
-    name: 'b',
-    ensure: 'present',
-  },
-]
-```
-
-The `create`/`update`/`delete` methods get called by the `SimpleProvider` base-class to change the system as requested by the catalog. The `name` argument is the name of the resource that is being processed. `should` contains the attribute hash - in the same format as `get` returns - with the values in the catalog.
-
-Further reading can be found in the Resource API:
-* [Resource Implementation](https://github.com/puppetlabs/puppet-specifications/blob/master/language/resource-api/README.md#resource-implementation-provider)
-* [Implmentation of simple providers](https://github.com/puppetlabs/puppet-specifications/blob/master/language/resource-api/README.md#implementing-simple-providers)
-* [Provider Features](https://github.com/puppetlabs/puppet-specifications/blob/master/language/resource-api/README.md#provider-features)
-
-### Unit testing
-
-The generated unit tests in `spec/unit/puppet/provider/foo_spec.rb` get automatically evaluated with `pdk test unit`.
-
-## Remote resources
-
-Support for remote resources is enabled through a `transport` class. A transport class contains the code for managing connections and processing information to and from the remote resource. For information on how to create a transport class, see the [Resource API specification](https://github.com/puppetlabs/puppet-specifications/tree/master/language/resource-api#transport).
-
-An example of a transport class:
-
-```ruby
-# lib/puppet/transport/device_type.rb
-module Puppet::Transport
-  # The main connection class to a PAN-OS API endpoint
-  class DeviceType
-    def initialize(context, connection_info)
-    # Initialization eg. validate connection_info
-    end
-
-    def verify(context)
-    # Test that transport can talk to the remote target
-    end
-
-    def facts(context)
-    # Access target, return a Facter facts hash
-    end
-
-    def close(context)
-    # Close connection, free up resources
-    end
-  end
-end
-```
-
-An example of a corresponding schema:
-
-```ruby
-# lib/puppet/transport/device_type.rb
-Puppet::ResourceAPI.register_transport(
-  name: 'device_type', # points at class Puppet::Transport::DeviceType
-  desc: 'Connects to a device_type',
-  # features: [], # future extension points
-  connection_info: {
-    host: {
-      type: 'String',
-      desc: 'The host to connect to.',
-    },
-    user: {
-      type: 'String',
-      desc: 'The user.',
-    },
-    password: {
-      type: 'String',
-      sensitive: true,
-      desc: 'The password to connect.',
-    },
-    enable_password: {
-      type: 'String',
-      sensitive: true,
-      desc: 'The password escalate to enable access.',
-    },
-    port: {
-      type: 'Integer',
-      desc: 'The port to connect to.',
-    },
-  },
-)
-```
-
-### Transport Schema keywords
-
-To align with [Bolt's inventory file](https://puppet.com/docs/bolt/latest/inventory_file.html), a transport schema prefers the following keywords (when relevant):
-
-* `uri`: use when you need to specify a specific URL to connect to. Bolt will compute the following keys from the `uri` when possible. In the future more url parts may be computed from the URI.
-* `protocol`: use to specify which protocol the transport should use for example `http`, `https`, `ssh` or `tcp`.
-* `host`: use to specify an IP or address to connect to.
-* `port`: the port the transport should connect to.
-* `user`: the user the transport should connect as.
-* `password`: the password for the specified user.
-
-Do not use the following keywords when writing a schema:
-
-* `implementations`: reserved by Bolt.
-* `name`: transports should use `uri` instead of name.
-* `path`: reserved as a uri part.
-* `query`: reserved as a uri part.
-* `remote-*`: any key starting with `remote-` is reserved for future use.
-* `remote-transport`: determines which transport to load. It is always the transport class named "declassified".
-* `run-on`: Bolt uses this keyword to determine which target to proxy to. Transports should not rely on this key.
-
-> Note: Bolt inventory requires you to set a name for every target and always use it for the URI. This means that there is no way to specify `host` separately from the host section of the `name` when parsed as a URI.
-
-After the device class, transport class and transport schema have been implemented, `puppet device` will be able to use the new provider, and supply it (through the device class) with the URL specified in the [`device.conf`](https://puppet.com/docs/puppet/5.3/config_file_device.html).
-
-* Further reading can be found in The [Resource API](https://github.com/puppetlabs/puppet-specifications/blob/master/language/resource-api/README.md#transports).
-
-### Puppet backwards compatibility
-
-To connect to a remote resource through `puppet device`, you must provide a device shim to maintain compatibility with Puppet. The device shim needs to interface the transport to puppet's config and runtime expectations.
-
-In the simplest case you can use the provided `Puppet::ResourceApi::Transport::Wrapper` like this:
-
-```ruby
-# lib/puppet/util/network_device/device_type/device.rb
-
-require 'puppet'
-require 'puppet/resource_api/transport/wrapper'
-# force registering the transport schema
-require 'puppet/transport/schema/device_type'
-
-module Puppet::Util::NetworkDevice::Device_type
-  class Device < Puppet::ResourceApi::Transport::Wrapper
-    def initialize(url_or_config, _options = {})
-      super('device_type', url_or_config)
-    end
-  end
-end
-```
-
-## Summary
-
-### Getting Started
-1. Download the [Puppet Development Kit](https://puppet.com/download-puppet-development-kit).
-2. Create a [new module](https://puppet.com/docs/pdk/latest/pdk_generating_modules.html) by running `pdk new module <MODULE_NAME>`.
-3. Open `.sync.yml` and add the follwing code to to add the `puppet-resource-api` gem:
-```
-# .sync.yml
----
-Gemfile:
-  optional:
-    ':development':
-      - gem: 'puppet-resource_api'
-spec/spec_helper.rb:
-  mock_with: ':rspec'
-```
-4. Run `pdk update` to apply the changes.
-5. Run `pdk new provider <provider_name>` to create the type and provider files.
-
-### The Type, Provider and Transport
-The type is a template for the nessesary resources such as `name` and `ensure`. More attributes can be added, as well as modified to match our resources. 
-
-The provider reads and enforces the state. An `initialize` method can  be used for establising connection. `get(context)` can be used to et a hash list of resources on the target system.
-The `create`/`update`/`delete` methods get called by the `SimpleProvider` base-class to change the system as requested by the catalog.
-`should`contins the attriute hash with the values in the catalog.
-See full description above for examples.
-
-Remote resource support is enable thourhg the `transport` class, which manages connections and information to and form remote resources. See above for an example transport class and a fll list of keywords for the transport class.
-
-For more detailed explainations, refer to the content above, or the [Resource API](https://github.com/puppetlabs/puppet-specifications/blob/master/language/resource-api/README.md) specification.
 
 ## Contributing
-We are always welcoming bug reports and pull requests on the Resource API, so that we can continue to improve it to the best of our ability. If you would like to contribute, [have a look at our GitHub](https://github.com/puppetlabs/puppet-resource_api).
+We are always welcoming bug reports and pull requests on the Resource API, so that we can continue to improve it to the best of our ability. If you would like to contribute, [have a look at our GitHub](https://github.com/puppetlabs/puppet-resource_api) and the [Resource API Backlog](https://github.com/puppetlabs/puppet-resource_api/projects/1).
 
-## Known Issues
 
-This gem is still under heavy development. This section is a living document of what is already done, and what items are still outstanding.
-
-Currently working:
-* Basic type and provider definition, using `name`, `desc`, and `attributes`.
-* Scalar puppet 4 [data types](https://puppet.com/docs/puppet/5.3/lang_data_type.html#core-data-types):
-  * String, Enum, Pattern
-  * Integer, Float, Numeric
-  * Boolean
-  * Array
-  * Optional
-  * Variant
-* The `canonicalize`, `simple_get_filter`, and `remote_resource` features.
-* All the logging facilities.
-* Executing the new provider under the following commands:
-  * `puppet apply`
-  * `puppet resource`
-  * `puppet agent`
-  * `puppet device` (if applicable)
+## Known Issues
 
 There are still a few notable gaps between the implementation and the specification:
-* Complex data types, like Hash, Tuple or Struct are not yet implemented.
 * Only a single runtime environment (the Puppet commands) is currently implemented.
 
 Restrictions of puppet:
@@ -377,25 +41,3 @@ Restrictions of puppet:
 Future possibilities:
 * [Multiple Providers](https://tickets.puppetlabs.com/browse/PDK-530)
 * [Commands API](https://tickets.puppetlabs.com/browse/PDK-847)
-
-### Cutting a release
-
-In some cases we need to manually cut a release outside of the regular puppet
-agent process.
-
-To do so, follow these instructions from a current `master` checkout:
-
-* Start the release branch with `git checkout -b release-prep`
-* Update `lib/puppet/resource_api/version.rb` to the new version
-* Update the CHANGELOG
-  * Have a [CHANGELOG_GITHUB_TOKEN](https://github.com/skywinder/github-changelog-generator#github-token) set in your environment
-  * run `rake changelog`
-  * double check the PRs to make sure they're all tagged correctly (using the new CHANGELOG for cross-checking)
-* Check README and other materials for up-to-date-ness
-* Commit changes with title "Release prep for \<VERSION>"
-* Upload and PR the release-prep branch to the puppetlabs GitHub repo
-* Check that CI is green and merge the PR
-* Run `rake release[upstream]` to release from your checkout
-  * make sure to use the name of your git remote pointing to the puppetlabs GitHub repo
-* Remove the release-prep branch
-* Send the release announcements using the template in [misc/ANNOUNCEMENT_TEMPLATE.md](misc/ANNOUNCEMENT_TEMPLATE.md)

data/lib/puppet/resource_api/version.rb

@@ -1,5 +1,5 @@
 module Puppet
   module ResourceApi
-    VERSION = '1.8.7'.freeze
+    VERSION = '1.8.8'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-resource_api
 version: !ruby/object:Gem::Version
-  version: 1.8.7
+  version: 1.8.8
 platform: ruby
 authors:
 - David Schmitt
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-17 00:00:00.000000000 Z
+date: 2020-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hocon
@@ -68,7 +68,6 @@ files:
 - lib/puppet/resource_api/value_creator.rb
 - lib/puppet/resource_api/version.rb
 - lib/puppet/util/network_device/simple/device.rb
-- misc/ANNOUNCEMENT_TEMPLATE.md
 - puppet-resource_api.gemspec
 homepage: https://github.com/puppetlabs/puppet-resource_api
 licenses:

data/misc/ANNOUNCEMENT_TEMPLATE.md

@@ -1,55 +0,0 @@
-Send out announcements for major new feature releases and high-impact bugfixes.
-
-For each release two announcements should be sent: an internal one and an external one.
-
-Both emails must be sent from the puppet-product-updates@puppet.com email alias. You must add yourself to the alias in order to have rights to send the email from that alias.
-
-### Internal email
-Send from the puppet-product-updates@puppet.com email alias to the internal-puppet-product-updates email address. This will send the announcement to internal only people and most internal groups have been auto-subscribed to that list, so it should hit everyone in the organisation. It may include specific internal-only information, but most of the core content should be the same as the external email. Indeed, it is acceptable for both emails to be the same if there is no internal only information.
-
-### External email
-Send from the puppet-product-updates@puppet.com email alias to the following external aliases: <puppet-announce@googlegroups.com>, <puppet-dev@googlegroups.com>, <puppet-users@googlegroups.com>, <voxpupuli@groups.io>.
-
-
-### Instructions on email content
-Before sending, do check that all links are still valid. Feel free to adjust the text to match better with the circumstances of the release, or add other news that are relevant at the time. If you make changes, consider committing them here, for the benefit of future-you.
-
-The github rendering of the markdown seems to copy&paste acceptably into Google Inbox.
-
-The [CHANGELOG](https://github.com/puppetlabs/puppet-resource_api/blob/master/CHANGELOG.md) is a good starting point for finding enhancements and bug-fixes.
-
-See [this post](https://groups.google.com/d/msg/puppet-dev/1R9gwkEIxHU/adWXJ0NfCAAJ) for an example.
-
----
-
-Subject: [ANN] Resource API X.Y.Z Release
-
-Hi all,
-
-We're pleased to announce that version X.Y.Z of the Resource API is being released today.
-
-The Resource API provides a simple way to create new native resources in the form of types and providers for Puppet. Using a little bit of ruby, you can finally get rid of that brittle exec, or manage that one API that eluded you until now.
-
-It is provided as a Ruby gem to be referenced within modules. Support for it has been included as an experimental feature in the Puppet Development Kit (see `pdk new provider --help`). Use the [Puppet 6 packages](https://puppet.com/blog/introducing-puppet-6) or the [resource_api module](https://forge.puppet.com/puppetlabs/resource_api) to deploy it in your infrastructure. Note that if you are using Puppet 6 packages, you will have to wait until the next release to upgrade.
-
-The new release of the Resource API provides the following enhancements:
-
-* A
-* B
-* C
-
-The new release also contains the following notable bugfixes:
-
-* D
-* E
-* F
-
-See the [CHANGELOG](https://github.com/puppetlabs/puppet-resource_api/blob/master/CHANGELOG.md) for a full list of changes.
-
-We encourage all module developers to review the Resource API and use it when creating types and providers. The [README](https://github.com/puppetlabs/puppet-resource_api/blob/master/README.md) gets you going quickly. To see some example code see [this simple Philips Hue type](https://github.com/da-ar/hue_rsapi) or [the Palo Alto firewall module](https://github.com/puppetlabs/puppetlabs-panos).
-
-Please let us know of your experiences with the Resource API, either here, on [Slack](https://slack.puppet.com/) (#forge-modules), or on the [github repo](https://github.com/puppetlabs/puppet-resource_api).
-
-
-Thanks,
-YOUR NAME