Skip to content

Commit 11a136b

Browse files
committed
Revert "(maint) update release docs"
For now we need to release out-of-band gem releases manually. This reverts commit 67015ee.
1 parent fa47385 commit 11a136b

File tree

1 file changed

+24
-3
lines changed

1 file changed

+24
-3
lines changed

README.md

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

343+
## Development
344+
345+
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.
346+
347+
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).
348+
343349
## Contributing
344350

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

347-
## Cutting a release
348-
349-
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.
353+
### Cutting a release
354+
355+
To cut a new release, from a current `master` checkout:
356+
357+
* Start the release branch with `git checkout -b release-prep`
358+
* Update `lib/puppet/resource_api/version.rb` to the new version
359+
* Update the CHANGELOG
360+
* Have a [CHANGELOG_GITHUB_TOKEN](https://github.com/skywinder/github-changelog-generator#github-token) set in your environment
361+
* run `rake changelog`
362+
* double check the PRs to make sure they're all tagged correctly (using the new CHANGELOG for cross-checking)
363+
* Check README and other materials for up-to-date-ness
364+
* Commit changes with title "Release prep for v\<VERSION>"
365+
* Upload and PR the release-prep branch to the puppetlabs GitHub repo
366+
* Check that CI is green and merge the PR
367+
* Run `rake release[upstream]` to release from your checkout
368+
* make sure to use the name of your git remote pointing to the puppetlabs GitHub repo
369+
* Remove the release-prep branch
370+
* Send the release announcements using the template in [misc/ANNOUNCEMENT_TEMPLATE.md](misc/ANNOUNCEMENT_TEMPLATE.md)

0 commit comments

Comments
 (0)