Skip to content

Build And Release

samatrhea edited this page Oct 4, 2025 · 8 revisions

Development Environment

ReqIFSharp is developed using Visual Studio 2022 and Jetbrains Rider.

The following tools are used by the Starion Group development team:

  • Visual Studio 2022 Professional (Community Edtion will work as well)
  • Jetbrains Rider
  • Jetbrains Resharper Ultimate 2022.1.2 or later
  • Git Extensions

Build

The ReqIFSharp solution contains two build configurations:

  • debug: used while developing new features
  • release: used to create a build for release

Release

The reqifsharp libraries are released as nuget packages on https://nuget.org. The release process is automated with a Github Action that is invoked manualy and is provided the version number: https://github.com/STARIONGROUP/reqifsharp/actions/workflows/release.yml

Before a release can be made, the following steps shall be followed and executed:

  1. Run all unit tests and verify that they pass (with the exception of those tests that may need a running server)
  2. Make sure the version numbers of the projects are incremented when things have changed; the project makes use of SEMVER. To bump all versions at once, uses the versionBump.sh script (usage: ./versionBump.sh x.y.z)
  3. Update the in the .csproj files; this will be visible on https://nuget.org and the content will be used to create a draft release note when invoking the release Github Action

Execute the release action once this has completed do the following steps

  1. Via the GitHub web-ui, update the draft release. The description includes the contents of the for each project in the solution
  2. rebase master from development
Clone this wiki locally