Skip to content

Release process

Jump to bottom
John R. D'Orazio edited this page Feb 20, 2021 · 1 revision

This page will explain how to prepare a new release of the BibleGet add-on for Microsoft Word.

Version number

Once all of the changes in the code have been tested and pushed to the development repository, the version number needs to be changed in the following places:

  • BibleGetIOSetup -> Organize your setup -> General information -> Product Version
  • BibleGetIO -> My Project -> Application -> Assembly information -> Assembly version AND File version

It shouldn't really matter much to change it here, I don't think:

  • BibleGetIO -> My Project -> Application -> Publish -> Publish version

Because we're not really using this publish functionality. If we were able to publish a new release to a Microsoft Store somewhere, or to turn a self-hosted folder into a Microsoft Store entry, then maybe we could use this kind of function. Until then it isn't really useful.

Product GUID

A new GUID must be generated in order to identify this specific version of the BibleGet Add-in for Word.

  • BibleGetIOSetup -> Organize your setup -> General information -> Product code : click on the three dots on the right hand side of the input, it should generate a new unique GUID. Copy this into the system clipboard. DO NOT change the Upgrade code, this must stay the same between versions so that the system is able to identify a previous version of the add-in that should be upgraded.
  • BibleGetIO -> My Project -> Application -> Assembly information -> GUID : paste the previously copied GUID into this input field, without the curly brackets
  • BibleGetIOSetup -> Configure the target system -> Shortcuts/Folders -> Shortcuts/Taskbar/Start Menu/Programs Menu/BibleGet IO/BibleGet IO for MSWord/Uninstall BibleGet IO for MSWord -> Behaviour -> Arguments : replace the GUID with the curly brackets following the /x parameter with the new updated GUID (copied to the clipboard from the first stop), it should be pasted along with the curly brackets

Build the release's executable

Now we are ready to build the release.

  • Make sure SingleImage and Any CPU are selected on the command bar.
  • From the Compile menu item click on Compile solution.
  • Make sure the build folder for the executable is not open, or the compiler will not be able to create the new executable there
  • Once the compile has completed successfully, any last commits can be made to the development branch (for example the version number changes and GUID changes will be a new commit)

Prepare a new release on Github

  • The Readme.md on the development branch can be updated on Github with the information about the new release
  • The development branch should be merged into the master branch on github
  • In the Releases area on Github, click on Draft a new release, make sure the master branch is selected as the branch to be tagged (target), and tag it with the release's version number (v + same number we gave in the Assembly information -> Product version), and give a title with the release's version number (Version + Assembly information -> Product version)
  • The changelog for this release can be summed up in the description area: this will be published to Sourceforge automatically as the Readme inside the folder for this release. If you want, you can paste in the whole readme from the master branch, but I don't think it's necessary, sourceforge already has a readme on the main page (which should be updated manually btw). One way or the other.
  • Drag and drop the executable from the build folder to the attachments area for the release on github. On my system this is at Documents -> Visual Studio 2015 -> Projects -> BibleGetIO -> BibleGetIOSetup -> BibleGetIOSetup -> Express -> SingleImage -> DiskImages -> DISK1 -> BibleGetIOMSWordAddInSetup.exe . This will be published automatically to a new folder for the release on Sourceforge.

Set new release as default on Sourceforge

  • You should now find a new folder published to sourceforge, named by the tag of the release (e.g. v3.0.1.9) at https://sourceforge.net/projects/bibleget/files/
  • Click and enter the folder, and to the right of the executable there is an ( ℹ️ ) information icon. Click on the icon, and set the checkbox Default download for: Microsoft Windows. Then click on the Save button.

The new release should now be the default for the download of the latest version. This can be seen here: https://sourceforge.net/projects/bibleget/best_release.json

If the "release" : {"filename" : } property's value corresponds with the latest published version, we're good! The release is now complete.

Clone this wiki locally