Skip to content

Making an HEC‐FDA Release

Jump to bottom
Brennan Beam edited this page Sep 11, 2024 · 1 revision

The "Release" action in the HEC-FDA repository is set to fire on a commit tag prefixed with v and using semantic versioning. For example, "v2.0.0" signifies the 2.0.0 release, while "ReproducibleBug", "v2", and "1.0.0" do not. The notation requires both the v, and the dot separated semantic version.

The act of tagging a commit is relatively simple. Git command line, and most GUI's will support this. The image below illustrates the workflow for tagging within the GitHub Desktop Client, which is my favorite Git GUI. There are three basic things to look out for when doing this.

  • Make sure you're on the main branch, otherwise your tag will not trigger the release
  • Navigate to the History Tab. Here you can tag commits from latest, or back in time.
  • Right click the commit you whish to publish from, and select the Tag context item. The GUI will guide the rest.

image

The "Release" action will run, which creates a release you should see under the Releases section of the repository home page. It will also upload a zipped version of the HEC-FDA published files, suffixed with the version number to the assets, along with zips of the source files.

Please update release notes here before sending out any notifications to the field announcing the release.

Clone this wiki locally