Skip to content

How to release a version

Chris Beer edited this page May 10, 2011 · 26 revisions

Ensure that you're on the master branch. Run all tests and ensure that they pass.

rake solr:spec rake solr:features

Create a frozen branch (version.number-frozen)

git checkout -b v.#-frozen

Update version number in /lib/blacklight.rb , under self.version

Update the links in the readme files to point at the correct version so we're not linking to the documents in master which may not be correct for the specific tagged release (change "master" to version number)

README.rdoc AND doc/README_INSTALLATION.rdoc (Seems not to be neccesary in current version, README.rdoc doesn't reference a specific version, and doc/ does not exist.

And push your new frozen branch with these changes back to shared repo:

git add . && git commit -m "changed version numbers for release" && git push origin v.#-frozen

Create new tag and push it to GitHub

git tag -a v#.#.# -m "Tagging Blacklight version #.#.#"

git push origin --tags

Create rails template installers in the projectblacklight.github.com repository (e.g. example commit)

create templates/#-#-#.rb with the following content:

`--- layout: template tag: "'v#.#.#'" branch: nil

`

Make the new release version the "latest": cp templates/#-#-#.rb templates/latest.rb

Add and commit the files. git add templates/#-#-#.rb templates/latest.rb && git commit -m "updated rails template installers for new release" && git push origin master

Fix JIRA to know about the release

Create a milestone in JIRA for the NEXT version: Browse Project / Versions / use form to add new version

Move any open tickets for released version to the next version: "Blacklight Plugin" >> Issues >> Unresolved by version: (current version you are releasing) >> Tools / Bulk Change >> select all issues >> Edit Issues >> Change/Fix Versions (to next version)

Mark milestone for release as released

Browse the project and select the 'Versions' link/tab

Click "Manage Versions" in the upper right hand corner of the list of released and unreleased versions

In the 'Operations' column, click 'Release' next to the version to be released.

Prepare announcement

Include URL to JIRA closed issues for version (Browse Project / Versions / click on version / click on eyeball icon in top right, -- copy URL. Maybe you want to tinyurl this ugly guy.)

Include URL to github commits between tags. github can show all commits between two versions with a URL of this form: http://github.com/projectblacklight/blacklight/compare/v2.5.0...v2.6.0 Replace with previous version and current release version tags.

Announce

Write a blog post with release notes at projectblacklight.org (how?)

Write emails announcing the release and linking the blog post to OSS4LIB, CODE4LIB, Blacklight Development (jrochkind questions whether it's really neccesary to publisize every release all over the place? But blacklight listserv definitely, of course.)

Change the topic of the Blacklight IRC channel (nope, we've permanently lost the ability to do this)

/topic Welcome to #blacklight | http://projectblacklight.org | Blacklight #.# is released!

Clone this wiki locally