Skip to content

Latest commit

 

History

History
125 lines (86 loc) · 4.39 KB

Create a release.md

File metadata and controls

125 lines (86 loc) · 4.39 KB
Raw

Sections

The first two sections deal with publishing a release, then staging things up for the next development cycle. Follow each section, in order very carefully.

Create and Publish a New Release

  • Check David Farrell's repo for issues (dnmfarrell/berrybrew), and fix if necessary

  • git checkout the branch that's to be merged into master

  • git pull to ensure we're up-to-date

  • If configuration directives have been added, removed or modified in the data\config.json that are part of the new release, copy that file to the dev\data\ directory

  • If new berrybrew commands are added, ensure they are also added to the Commands section in the README.md file

  • Ensure all unit tests pass per Unit testing

  • Execute the perl dev\release.pl script, which:

    • Compile the bbapi.dll API library
    • Compile the berrybrew.exe binary
    • Compile the berrybrew-ui.exe UI binary
    • Collect the JSON configuration files from the dev\data directory
    • Build the bundled zip archive, and places it into the download/ directory
    • Verifies the manifest of files installed/uninstalled are correct
    • Updates the MSI installer script with berrybrew and perl version info
    • Creates the MSI installer program
    • Perform SHA checksum tasks on the new zip archive and MSI installer
    • Update the copyright year in the LICENSE file
    • Update the copyright year in the CONTRIBUTING.md file
    • Update the README.md file with the zip and installer's new SHA sum
    • Update the README.md file with the new version from the API's Version() method
    • Sets the date in the Changes file for the release version
    • Creates a Markdown version of the Changes file

  • Test the installer: Run the installer by executing the bin\berrybrewInstaller.exe binary. Ensure berrybrew works correctly. Then, uninstall it via Add/Remove programs. Ensure the C:\Program Files (x86)\berrybrew directory no longer exists

  • If you had any custom configuration files in place before running the dev\release.pl script, run perl dev\release_post.pl to put them back to their proper location

  • On a clean platform, run the self-extracting installer from the download/ directory, and ensure that both the berrybrew, and Perl versions are correct

  • git commit -a -m "release x.xx"

  • git push

  • Ensure everything looks proper within the newly published release branch

  • In Github, create a new Pull Request from the release branch, and merge it into the master branch

  • Check out master and ensure everything appears proper within the master branch

    • git checkout master
    • git pull
    • bin\berrybrew version (should be the updated version number)

  • Tag the new master branch as a release, and push it

    • git tag vx.xx
    • git push --tags

  • Update David Farrell's berrybrew repository:

    • git clone https://[email protected]/dnmfarrell/berrybrew bb-dnm
    • cd bb-dnm
    • git remote add stevieb9 https://github.com/stevieb9/berrybrew
    • git pull stevieb9 master
    • git push

  • Close off any issues in David's dnmfarrell/berrybrew repository

  • Delete the merged branch in Github

Prepare a Branch for the Next Release Cycle

Execute perl dev/release_cycle.pl, which will:

  • Check out the master branch
  • git pull to ensure it's up-to-date
  • Locally create a new branch named vX.XX (where X.XX is the bumped version number)
  • Updates the version in the Version() method in src\berrybrew.cs file
  • Updates the Changes file with a new version section
  • Commits the changes
  • Pushes the new branch

Updates for the Next Release

  • Check out the version branch: git checkout vx.xx

  • Ensure it's up-to-date: git pull

  • Create a working branch: git checkout -b some_feature, and perform your work

  • Push the new branch after making commits: git push origin some_feature

  • After all tests pass, create a Pull Request for the feature branch into the new version branch

  • Check out the new version branch git checkout vx.xx and update: git pull

  • Run all unit tests

  • Repeat this Release Cycle

© 2016-2023 by Steve Bertrand