Skip to content

Commit 67015ee

Browse files
committed
(maint) update release docs
1 parent 0c6ccda commit 67015ee

File tree

1 file changed

+3
-24
lines changed

1 file changed

+3
-24
lines changed

README.md

Lines changed: 3 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -231,31 +231,10 @@ Future possibilities:
231231
* [Multiple Providers](https://tickets.puppetlabs.com/browse/PDK-530)
232232
* [Commands API](https://tickets.puppetlabs.com/browse/PDK-847)
233233

234-
## Development
235-
236-
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.
237-
238-
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).
239-
240234
## Contributing
241235

242236
Bug reports and pull requests are welcome on GitHub at https://github.com/puppetlabs/puppet-resource_api.
243237

244-
### Cutting a release
245-
246-
To cut a new release, from a current `master` checkout:
247-
248-
* Start the release branch with `git checkout -b release-prep`
249-
* Update `lib/puppet/resource_api/version.rb` to the new version
250-
* Update the CHANGELOG
251-
* Have a [CHANGELOG_GITHUB_TOKEN](https://github.com/skywinder/github-changelog-generator#github-token) set in your environment
252-
* run `rake changelog`
253-
* double check the PRs to make sure they're all tagged correctly (using the new CHANGELOG for cross-checking)
254-
* Check README and other materials for up-to-date-ness
255-
* Commit changes with title "Release prep for v\<VERSION>"
256-
* Upload and PR the release-prep branch to the puppetlabs GitHub repo
257-
* Check that CI is green and merge the PR
258-
* Run `rake release[upstream]` to release from your checkout
259-
* make sure to use the name of your git remote pointing to the puppetlabs GitHub repo
260-
* Remove the release-prep branch
261-
* Send the release announcements using the template in [misc/ANNOUNCEMENT_TEMPLATE.md](misc/ANNOUNCEMENT_TEMPLATE.md)
238+
## Cutting a release
239+
240+
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.

0 commit comments

Comments
 (0)