Skip to content

Latest commit

 

History

History
62 lines (39 loc) · 2.58 KB

RELEASE.md

File metadata and controls

62 lines (39 loc) · 2.58 KB
Raw

This document outlines the process for creating a new BLT release.

To perform a release:

  1. Check build statuses
  2. Run tests locally.
  3. Generate and commit updated CHANGELOG.md.
  4. Create a release

Check build statuses

Testing

Prerequisites

In order to use these testing instructions:

  • The blt alias must be installed.
  • Your LAMP stack must have host entry for http://local.blted8.com pointing to ./blted8/docroot.
  • MySQL must use mysql://drupal:drupal@localhost/drupal:3306.
  • In order to test Drupal VM, you must install VirtualBox and Vagrant. See Drupal VM for more information.

Execute tests

./scripts/blt/pre-release-tests.sh [tag]

Update CHANGELOG.md

Prerequisites

  • BLT's dependencies must be installed by running composer install in the BLT directory.
  • Ruby 2.2.2+ must be installed. You may use RVM to use a directory specific version of Ruby. E.g., rvm use 2.2.2.
  • skywinder/github-changelog-generator must be installed. E.g., gem install github_changelog_generator.
  • Procure a github api token.
  • Determine the version of your future release.

Execute command

Then, generate your release notes via:

./vendor/bin/robo release-notes [tag] [token]

This will update CHANGELOG.md and create a commit locally.

Create a release

To both generate release notes and also create a new release on GitHub, execute:

./vendor/bin/robo release --update-changelog [tag] [token]

This is a potentially destructive command. It will:

  • Perform a hard reset on the 8.x and 8.x-release branches of your local repository
  • Update CHANGELOG.md, commit, and push upstream
  • Merge 8.x into 8.x-release and push upstream
  • Create a draft release on GitHub, populated with release notes