From 11a136b0f40abd8465012e7c786d35cfaa7a83d2 Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Wed, 13 Mar 2019 16:31:53 +0000 Subject: [PATCH 1/3] Revert "(maint) update release docs" For now we need to release out-of-band gem releases manually. This reverts commit 67015ee442fc062a4884422a0c38d3e158f83cd2. --- README.md | 27 ++++++++++++++++++++++++--- 1 file changed, 24 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f2c8329a..46c12eac 100644 --- a/README.md +++ b/README.md @@ -340,10 +340,31 @@ Future possibilities: * [Multiple Providers](https://tickets.puppetlabs.com/browse/PDK-530) * [Commands API](https://tickets.puppetlabs.com/browse/PDK-847) +## Development + +After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. + +To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). + ## Contributing Bug reports and pull requests are welcome on GitHub at https://github.com/puppetlabs/puppet-resource_api. -## Cutting a release - -To cut a new release, follow the ["Special case: the resource API" instructions](https://confluence.puppetlabs.com/display/systemsEngineering/Puppet+Agent+Release+Lead+Guide) on confluence. +### Cutting a release + +To cut a new release, 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 v\" +* 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) From f8cc65a4e24136599dced24d240885d462db771d Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Wed, 13 Mar 2019 16:33:42 +0000 Subject: [PATCH 2/3] (maint) update instructions for manual releases --- README.md | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 46c12eac..4f3ca1c1 100644 --- a/README.md +++ b/README.md @@ -340,19 +340,16 @@ Future possibilities: * [Multiple Providers](https://tickets.puppetlabs.com/browse/PDK-530) * [Commands API](https://tickets.puppetlabs.com/browse/PDK-847) -## Development - -After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. - -To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). - ## Contributing Bug reports and pull requests are welcome on GitHub at https://github.com/puppetlabs/puppet-resource_api. ### Cutting a release -To cut a new release, from a current `master` checkout: +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 From d7dade3b99777fab7fd78b0a60a8264c9a60b7bf Mon Sep 17 00:00:00 2001 From: David Schmitt Date: Wed, 13 Mar 2019 16:36:32 +0000 Subject: [PATCH 3/3] Release prep for v1.8.1 --- CHANGELOG.md | 15 +++++++++++++++ lib/puppet/resource_api/version.rb | 2 +- 2 files changed, 16 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e696edc3..8db4901c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,20 @@ All significant changes to this repo will be summarized in this file. +## [v1.8.1](https://github.com/puppetlabs/puppet-resource_api/tree/v1.8.1) (2019-03-13) +[Full Changelog](https://github.com/puppetlabs/puppet-resource_api/compare/v1.8.0...v1.8.1) + +**Fixed bugs:** + +- \(maint\) Fixes sensitive transport values where absent keys are wrapped [\#161](https://github.com/puppetlabs/puppet-resource_api/pull/161) ([da-ar](https://github.com/da-ar)) + +**Merged pull requests:** + +- 1.6.x mergeup [\#162](https://github.com/puppetlabs/puppet-resource_api/pull/162) ([DavidS](https://github.com/DavidS)) +- \(FM-7829\) Update README with transports examples [\#160](https://github.com/puppetlabs/puppet-resource_api/pull/160) ([willmeek](https://github.com/willmeek)) +- \(maint\) update release docs [\#159](https://github.com/puppetlabs/puppet-resource_api/pull/159) ([DavidS](https://github.com/DavidS)) +- Improve travis cells and testing [\#145](https://github.com/puppetlabs/puppet-resource_api/pull/145) ([DavidS](https://github.com/DavidS)) + ## [v1.8.0](https://github.com/puppetlabs/puppet-resource_api/tree/v1.8.0) (2019-02-26) [Full Changelog](https://github.com/puppetlabs/puppet-resource_api/compare/v1.7.0...v1.8.0) @@ -22,6 +36,7 @@ All significant changes to this repo will be summarized in this file. **Merged pull requests:** +- Release prep for v1.8.0 [\#158](https://github.com/puppetlabs/puppet-resource_api/pull/158) ([DavidS](https://github.com/DavidS)) - \(FM-7726\) cleanups for the transport [\#153](https://github.com/puppetlabs/puppet-resource_api/pull/153) ([DavidS](https://github.com/DavidS)) - \(FM-7691,FM-7696\) refactoring definition handling in contexts [\#150](https://github.com/puppetlabs/puppet-resource_api/pull/150) ([DavidS](https://github.com/DavidS)) diff --git a/lib/puppet/resource_api/version.rb b/lib/puppet/resource_api/version.rb index 3b249858..75d72743 100644 --- a/lib/puppet/resource_api/version.rb +++ b/lib/puppet/resource_api/version.rb @@ -1,5 +1,5 @@ module Puppet module ResourceApi - VERSION = '1.8.0'.freeze + VERSION = '1.8.1'.freeze end end