kienan
/
puppet-strings
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add common gem release process docs

This commit is contained in:
David Schmitt 2018-06-26 08:29:46 +01:00
parent 6b5c2dbd45
commit d4c31eaf86
3 changed files with 61 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
CONTRIBUTING.md
View File

@ -76,6 +76,25 @@ a ticket number.
* After feedback has been given we expect responses within two weeks. After two
weeks will may close the pull request if it isn't showing any activity.
## 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-strings/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\<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)
# Additional Resources
* [More information on contributing](http://links.puppet.com/contribute-to-puppet)

2
Rakefile
View File

@ -1,4 +1,4 @@
require 'rubygems'
require 'bundler/gem_tasks'
require 'puppetlabs_spec_helper/rake_tasks'
require 'puppet-lint/tasks/puppet-lint'

40
misc/ANNOUNCEMENT_TEMPLATE.md Normal file
View File

@ -0,0 +1,40 @@
Send out announcements for major new feature releases, and high-impact bugfixes to <puppet-announce@googlegroups.com>, <puppet-dev@googlegroups.com>, <puppet-users@googlegroups.com>, <voxpupuli@groups.io>, and the puppet internal mailing lists <dev@puppet.com> and <tech-discuss@puppet.com>.
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-strings/blob/master/CHANGELOG.md) is a good starting point for finding enhancements and bug-fixes.
---
Subject: [ANN] Puppet Strings vX.Y.Z Release
Hi all,
We're pleased to announce that version X.Y.Z of the Puppet Strings is being released today.
Puppet Strings provides a simple way to extract source documentation into useful docs. It is provided as a Ruby gem to be referenced within modules. See the [README](https://github.com/puppetlabs/puppet-strings#installing-puppet-strings) for documentation on how to install and use it.
The new release of Puppet Strings 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-strings/blob/master/CHANGELOG.md) for a full list of changes
We encourage all module developers to review puppet-strings and use it when creating modules.
Please let us know of your experiences with Puppet Strings, either here, on [Slack](https://slack.puppet.com/) (#forge-modules), or on the [github repo](https://github.com/puppetlabs/puppet-strings).
Thanks,
YOUR NAME