Skip to content

End of milestone procedure

Arnaud Declercq edited this page Jul 10, 2025 · 16 revisions
  1. Freeze current version

    • Run the alpha installer from the date of the release
    • Locate the latest json file from C:\ProgramData\BHoM\Upgrades\BHoMUpgrades\Upgrades. The name should be vXY.json where X and Y are the major and minor version number of the milestone that is currently ending.
    • Copy that file into the Upgrades folder of the BHoMUpgrades project.
    • Make sure that file appears in Visual Studio and that CopyToOutputDirectory is set to Always
  2. Prepare new version

    • Create a new cs file in the CustomUpgrades folder of the BHoMUpgrades project.
    • Below is the template. Just replace X with the major version number and Y with the minor version number. make sure those version numbers are matching the milestone that is currently starting.
/*
 * This file is part of the Buildings and Habitats object Model (BHoM)
 * Copyright (c) 2015 - 2025, the respective contributors. All rights reserved.
 *
 * Each contributor holds copyright over their respective contributions.
 * The project versioning (Git) records all such contribution source information.
 *                                           
 *                                                                              
 * The BHoM is free software: you can redistribute it and/or modify         
 * it under the terms of the GNU Lesser General Public License as published by  
 * the Free Software Foundation, either version 3.0 of the License, or          
 * (at your option) any later version.                                          
 *                                                                              
 * The BHoM is distributed in the hope that it will be useful,              
 * but WITHOUT ANY WARRANTY; without even the implied warranty of               
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the                 
 * GNU Lesser General Public License for more details.                          
 *                                                                            
 * You should have received a copy of the GNU Lesser General Public License     
 * along with this code. If not, see <https://www.gnu.org/licenses/lgpl-3.0.html>.      
 */

using BH.oM.Versioning;
using System.Collections.Generic;
using System;

namespace BH.Upgraders
{
    [Upgrader(X, Y)]
    public static class vXY
    {
        /***************************************************/
        /**** Public Methods                            ****/
        /***************************************************/

        /***************************************************/
    }
}
  1. Update post-build events

    • update the version number of the target json file on the line that calls PostBuild.exe
  2. Update AssemblyFileVersion of

    • BHoMUpgrades
    • PostBuild (This one has an old format for the project file so the assembly info is stored in \Properties\AssemblyInfo.cs)
Clone this wiki locally