Creating Releases

There are a few steps towards creating a new release, in part because the project spans several linked repositories.

Update Release Notes

Go to https://github.com/OpenChemistry/avogadrolibs/releases

You should be able to edit the release notes. In some cases, you'll want to pull in changes tagged in other repositories, e.g. https://github.com/OpenChemistry/avogadroapp/releases

Edit and clean up, for example multiple commits for translations updates.

Save the markdown - you'll want this in a few places (e.g., the releases, the website, the forum, etc.)

Updating repositories

• update avogadro-i18n
  • make sure sync-translations is run: https://github.com/OpenChemistry/avogadro-i18n/actions/workflows/sync-translations.yml
• create pull requests to bump the version number
  • avogadrolibs - edit SECURITY.md and CMakeLists.txt
  • avogadroapp - also edit avogadro/metainfo/org.openchemistry.Avogadro2.metainfo.xml
    • add some brief release highlights

Tagging a Release

In most cases, the build scripts are set to create release binaries once a release is tagged.

export version=1.103.0 # or whatever release you're creating

# in openchemistry repository
# tag each sub-repository
for dir in avogadrolibs avogadroapp crystals molecules fragments avogadro-i18n avogenerators avogadrodata; do 
  (cd $dir;
  git pull origin
  git tag -s $version -m "Avogadro $version release"
  git push origin $version
  );
done

# now push a tag to openchemistry with the tagged sub repositories
git tag -s $version -m "Avogadro $version release"
git push origin $version

Grab Release Binaries

• The signed Windows release should be available through SignPath
• The signed Mac releases should be available through the appropriate actions https://github.com/OpenChemistry/avogadrolibs/actions
  • e.g., there will be a build associated with the tag
• There should be an unsigned Windows MSIX through the action to upload to the Microsoft Store for signing

Upload these on https://github.com/OpenChemistry/avogadrolibs/releases and https://github.com/OpenChemistry/avogadroapp/releases

Update Website

Bump the version numbers at https://github.com/avogadro/two.avogadro.cc/ for the new release and add the release notes:

• source/config.py
• source/install/versions/v1101.md
• source/install/versions/avogadro2.md

Post Release Notes

Post the release announcement on https://discuss.avogadro.cc/