Publishing the Release - Nice3point/RevitTemplates GitHub Wiki

The entire release process in different configurations is available in the cloud, you no longer need to manually carry out routine operations to deliver a product to your users. The templates contain customized workflows for some popular pipelines.

• Publishing Releases
  • Updating the Changelog
  • Creating a new Release from the JetBrains Rider
  • Creating a new Release from the Terminal
  • Creating a new Release on GitHub
  • Creating a new release on Azure DevOps
• Dependency conflicts
  • Dependency isolation
  • Dependency repacking

Releases are managed by creating new Git tags. A tag in Git used to capture a snapshot of the project at a particular point in time, with the ability to roll back to a previous version.

Tags must follow the format version or version-stage.n.date for pre-releases, where:

• version specifies the version of the release:
  • 1.0.0
  • 2.3.0
• stage specifies the release stage:
  • alpha - represents early iterations that may be unstable or incomplete.
  • beta - represents a feature-complete version but may still contain some bugs.
• n prerelease increment (optional):
  • 1 - first alpha prerelease
  • 2 - second alpha prerelease
• date specifies the date of the pre-release (optional):
  • 250101
  • 20250101

For example:

For releases, changelog for the release version is required.

To update the changelog:

1. Navigate to the solution root.
2. Open the file Changelog.md.
3. Add a section for your version. The version separator is the # symbol.
4. Specify the release number e.g. # 1.0.0 or # 25.01.01 v1.0.0, the format does not matter, the main thing is that it contains the version.
5. In the lines below, write a changelog for your version, style to your taste. For example, you will find changelog for version 1.0.0, do the same.
6. Make a commit.

JetBrains provides a handy UI for creating a tag, it can be created in a few steps:

1. Open JetBrains Rider.

2. Navigate to the Git tab.

3. Click New Tag... and create a new tag.

   

4. Navigate to the Git panel.

5. Expand the Tags section.

6. Right-click on the newly created tag and select Push to origin.

   

   This process will trigger the Release workflow and create a new Release on GitHub.

Alternatively, you can create and push tags using the terminal:

1. Navigate to the repository root and open the terminal.

2. Use the following command to create a new tag:

   git tag 'version'

   Replace version with the desired version, e.g., 1.0.0.

3. Push the newly created tag to the remote repository using the following command:

   git push origin 'version'

To create releases directly on GitHub:

1. Navigate to the Actions section on the repository page.

2. Select Publish Release workflow.

3. Click Run workflow button.

4. Specify the release version and click Run.

   

To create releases directly on Azure:

1. Navigate to the Pipelines section on the project page.

2. Click New pipeline button and select the source repository.

3. Save your pipeline.

4. Click Run pipeline button.

5. Specify the release version and click Run.

   

Plugins often use third-party dependencies and plugins from other developers may use these dependencies, but of different versions, causing Revit to conflict and crash. There is no way to control this process, so there are several ways to resolve this issue:

Starting with Revit version 2026, it provides dependency isolation in a separate context. This helps you to use any version of dependencies, in the same domain.

To enable it, modify the .addin manifest:

<RevitAddIns>
    <AddIn Type="Application">
        <Name>RevitAddin</Name>
        <Assembly>RevitAddin\RevitAddin.dll</Assembly>
    </AddIn>
    <ManifestSettings>
        <UseRevitContext>False</UseRevitContext>
        <ContextName>RevitAddin</ContextName>
    </ManifestSettings>
</RevitAddIns>

For older Revit versions before 2026, you can use ILRepack, a tool that repacks multiple DLLs into one. It does not support repackaging C++ dependencies, and may be unstable in some complex scenarios, so it is not recommended, but it is the only solution.

To enable it, set the IsRepackable property to true. For C++ dependencies or dependencies that cause issues, add to the RepackBinariesExcludes property:

<PropertyGroup>
    <IsRepackable Condition="'$(RevitVersion)' &lt; '2026'">true</IsRepackable>
    <RepackBinariesExcludes>$(AssemblyName).UI.dll;System*.dll</RepackBinariesExcludes>
</PropertyGroup>