Creating a new release

This repo contains multiple active versions. All development should occur in working branches before being merged into the specific version branch.

When you're ready to create a new release, follow these instructions.

Version 6:

1. Create a release branch

• From the v6 branch, create a new release branch following the pattern v6/task-description. An example would be v6/bugfix-marquee.
• Do whatever work it is that you do.
• Update the new version in package.json. You also need to update the version in the package.json files inside each of the package folders:
  • ./package.json: 1 instance
  • ./burf-base/package.json: 1 instance
  • ./burf-customizations/package.json: 3 instances
  • ./burf-theme/package.json: 2 instances
  • ./burf-tools/package.json: 2 instances
• Add a section in CHANGELOG.md describing changes introduced by this release.
• Stage all changes and commit as normal.

2. Push your release branch and open a pull request to v6 to merge

• You'll need to do a code review before closing the pull request and finalizing the release. Once you do, merge and delete your working branch.

3. Create the tag

• In tower, make sure your local v6 branch is up to date.
• Then right click it and select create new tag from v6.
• Set the name to the current version.
• Push to remote.

4. Create the release

• Head to the releases page (https://github.com/bu-ist/responsive-foundation/releases/).
• Draft a new release, and select your release number.
• Describe the release and add items from CHANGELOG.md in the description.
• As soon as you create a new release, the Publish all packages to npmjs action will run. It will use the code from that release to publish a npm package.

5. Update the child starter themes

• v6
  • Responsive Child Starter 3x block-editor

Version 5 or previous:

1. Create a release branch

• From the v5 branch, create a new release branch following the pattern v5/task-description. An example would be v5/bugfix-marquee.
• Do whatever work it is that you do.
• Update the new version in package.json. IN v5 ONLY you also need to update the version in the package.json files inside each of the package folders:
  • ./package.json: 5 instances
  • ./burf-base/package.json: 1 instance
  • ./burf-customizations/package.json: 2 instances
  • ./burf-theme/package.json: 2 instances
  • ./burf-tools/package.json: 2 instances
• Run grunt build
• Add a section in CHANGELOG.md describing changes introduced by this release.
• Stage all changes and commit as normal.
• NOTE: If you are introducing breaking changes, you should create a new version branch from the previous version. IE: Say 5.1.0 removes support for the letter E. Make a new branch named v5.0 that can be used on existing sites and v5 will continue to be the latest in the v5 lineage.

2. Push your release branch and open a pull request to v5 to merge

• You'll need to do a code review before closing the pull request and finalizing the release. Once you do, merge and delete your working branch.

3. Create the tag

• In tower, make sure your local v5 branch is up to date.
• Then right click it and select create new tag from v5.
• Set the name to the current version.
• Push to remote.

4. Create the release

• Head to the releases page (https://github.com/bu-ist/responsive-foundation/releases/).
• Draft a new release, and select your release number.
• Describe the release and add items from CHANGELOG.md in the description.
• v5+ ONLY - As soon as you create a new release, the Publish all packages to npmjs action will run. It will use the code from that release to publish a npm package.

5. Update the framework and child starter themes

• v3
  • Responsive Framework 2
  • Responsive Framework 3
• v4
  • Responsive Child Starter 2x
  • Static Starter
• v5
  • Responsive Child Starter 3x

6. Let Everyone Know!

• Paste the release link in Slack (#id-product-updates) with a summary of notes (e.g. https://github.com/bu-ist/responsive-foundation/releases/tag/1.0.1).