Source Release for BES
This pages covers the steps required to release the BES software for Hyrax.
We now depend on the CI/CD process to build binary packages and to test the source builds.
- 1 The Release Process
- 1.1 Verify the code base
- 1.2 Determine the scope of API/ABI changes in C++ sources
- 1.3 Update Release Files
- 1.4 Commit Changes
- 1.5 Tag & Release
- 1.6 Publish and Sign
- 1.7 Get the DOI from Zenodo
1 The Release Process
- Tip: If, while working on the release, you find you need to make changes to the code and you know the CI build will fail, do so on a release branch that you can merge and discard later. Do not make a release branch if you don't need it, since it complicates making tags.
1.1 Verify the code base
- We release using the master branch. The code on master must pass the CI build.
- Make sure that the source code you're using for the following steps is up-to-date. (git pull)
1.2 Determine the scope of API/ABI changes in C++ sources
Determine the new software version (assuming you don't already know the extent of the changes that have been made)
- For C++, build a file of the methods and their arguments using the command:
- nm .libs/libdap.a | c++filt | grep ' T .*::' | sed 's@.* T \(.*\)@\1@' > libdap_funcs
- and compare that using diff on the previous release's library.
Assess the changes you find based on the following rules for the values of CURRENT,REVISION, and AGE
- No interfaces changed, only implementations (good): ==> Increment REVISION.
- Interfaces added, none removed (good): ==> Increment CURRENT, increment AGE, set REVISION to 0.
- Interfaces removed or changed (BAD, breaks upward compatibility): ==> Increment CURRENT, set AGE and REVISION to 0.
The current value of CURRENT,REVISION, and AGE can be found in configure.ac:
LIB_DIS_CURRENT=14 LIB_DIS_AGE=6 LIB_DIS_REVISION=1
1.3 Update Release Files
Once you have determined the new values of the CURRENT:REVISION:AGE strings then:
- Edit the configure.ac and update the version values to the new ones.
- Update the text documentation files and version numbers in the configuration files:
1.3.1 Update the ChangeLog file.
Use the script gitlog-to-changelog (which can be found with Google) to update the ChangeLog file by running it using the --since="<date>" option with a date one day later in time than the newest entry in the current ChangeLog.
- gitlog-to-changelog --since="1970-01-01"
- (Specify a date one day later than the one at the top of the existing ChangeLog file.)
Save the result to a temp file and combine the two files:
- cat tmp ChangeLog > ChangeLog.tmp; mv ChangeLog.tmp ChangeLog
If you're making the first ChangeLog entries, then you'll need to create the ChangeLog file first.
Tip: When you're making the commit log entries, use line breaks so ChangeLog will be readable. That is, use lines < 80 characters long.
1.3.2 Update the NEWS file
To update the NEWS file, just read over the new ChangeLog entries and summarize.
1.3.3 Update the Version Numbers for Humans
- Determine the human version number. This appears to be a somewhat subjective process.
- Edit each of the Affected Files and update the human version number.
- Affected Files
- *.spec (In the BES it's bes.spec.*)
- debian/changelog (see  Debian ChangeLog)
- .travis.yml (for BES only; edit the LIBDAP_RPM_VERSION in the env: global: section)
- README.md (Add the libdap version the README.md)
It's helpful to have, in the NEWS file and the Web site and the release notes, a list of the Jira tickets that have been closed since the last release. The best way to do this is to goto Jira's Issues page and look at the Tickets closed recently item. From there, click on Advanced and edit the time range so it matches the time range since the past release to now, then Export that info as an excel spreadsheet (the icon with a hat and a down arrow). YMMV regarding how easy this is and Jira's UI changes often.
1.3.4 Update the RPM dependencies
In the RPM .spec file, update the dependencies as needed.
- Affected Files
- *.spec (In the BES it's bes.spec.*')
1.3.5 Update the internal library version numbers
There are really 2 version numbers for each of these project items. The human version (like bes-3.17.5) and the library API/ABI version which is represented as CURRENT:REVISION:AGE. There are special rules for when each of the numbers in the library API/ABI version get incremented that are triggered by the kinds of changes that where made to the code base. The human version number is more arbitrary. So for example, we might make a major API/ABI change and have to change to a new Libtool version like 25:0:0 but the human version might only change from bes-3.17.3 to bes-3.18.0
The rules for shared image version numbers:
- No interfaces changed, only implementations (good): Increment REVISION.
- Interfaces added, none removed (good): Increment CURRENT, increment AGE, set REVISION to 0.
- Interfaces removed or changed (BAD, breaks upward compatibility): Increment CURRENT, set AGE and REVISION to 0.
See How to see the scope of API/ABI changes in C++ sources below for gruesome details. Often basic knowledge of the edits is good enough.
- Affected Files
1.3.6 Update the module version numbers for humans
In bes/modules/common, check that the file all-modules.txt is complete and update as needed. Then run:
for d in `cat all-modules.txt` do ./version_update_modules.sh -v $d done
This will update the patch number (x.y.patch) for each of the named modules.
If a particular module has significant fixes, hand edit the number, in the Makefile.am.
See below for special info about the HDF4/5 modules (which also applies to any modules not in the BES GitHub repo).
1.3.7 For the BES HDF4/5 modules (BES only)
- Goto those directories and update the ChangeLog, NEWS, README, and INSTALL files (even though INSTALL is not used by many).
- Update the module version numbers in their respective Makefile.am files.
- Commit and Push these changes.
1.4 Commit Changes
- Commit and push the BES code. Wait for the CI/CD builds to complete. You must be working on the master branch to get the CD package builds to work.
1.5 Tag & Release
1.5.1 Tag the BES code
- Tag the bes code using command line git in your local (up-to-date) bes project
- git tag -a version-<numbers> -m "Version <number>"
- git push origin version-<numbers>
- If this is part of a Hyrax Release, then tag this point in the master branch with the Hyrax release number
- git tag -a hyrax-<numbers> -m "Hyrax <number>"
- git push origin hyrax-<numbers>
- NB: Instead of tagging the HDF4/5 modules, use the saved commit hashes that git tracks for submodules. This cuts down on the bookkeeping for releases and removes one source of error.
1.5.2 Create the release on Github
- Goto the BES project page in GitHub
- Choose the releases tab.
- On the Releases page click the 'Tags' tab.
- On the Tags page, locate the tag (created above) associated with this new release.
- Click the ellipses (...) located on the far right side of the version-x.y.z tag 'frame' for this release and and choose Create release.
- Enter a title for the release
- Copy the most recent text from the NEWS file into the describe field
- Click Publish release or Save draft.
- If you have previously edited the release page you can click Update this release
1.6 Publish and Sign
When the release is made on GitHub the source tar bundle is made automatically. However, this bundle is not the one we wish to publish because it requires people to have autoconf installed. Rather we want to use the result of "make dist" which will have the configure script pre-generated.
All you need do is build the tar file using make list, sign it, and push (or pull) these files onto www.opendap.org/pub/source.
- Go to the bes project on your local machine and run make dist which will make a bes-x.y.z,tar.gz file at the top level of the bes project.
- Use gpg to sign the tar bundle:
- gpg --detach-sign --local-user email@example.com bes-x.y.z.tgz
- Use sftp to push the signature file and the tar bundle to the /httpdocs/pub/source directory on www.opendap.org
- (Assuming your current working directory is the top of the bes project)
- sftp firstname.lastname@example.org
- cd httpdocs/pub/source
- put bes-x.y.z.tgz.sig
- put bes-x.y.z.tgz
- Check your work!
- Download the source tar bundle and signature from www.opendap.org.
- Verify the signature:
- gpg --verify bes-x.y.z.tgz.sig bes-x.y.z.tgz
1.7 Get the DOI from Zenodo
- Goto Zenodo
- Look at the 'upload' page. If there is nothing there (perhaps because you are not jhrg or whoever set up the connection between the BES project and Zenodo) you can use the search bar to search for bes.
- Since the libdap, BES and OLFS repositories are linked to Zenodo, the newly-tagged code is uploaded to Zenodo automatically and a DOI is minted for us.
- Click on the new version, then click on the DOI tag in the pane on the right of the page for the given release.
- Copy the DOI as markdown from the window that pops up and paste that into the info for the version back in Github land.
- Also paste that into the README file. Commit using [skip ci] so we don't do a huge build (or do the build, it really doesn't matter that much).
Tip: If you are trying to locate the libdap releases in Zenodo you have to search for the string: libdap4