Skip to content

How to use our github action to build the solution and the msi installer

Jump to bottom
Alaa Rihan - Temco Controls edited this page Aug 23, 2023 · 3 revisions

We've implemented a GitHub action that handles the automated building of the solution as well as generating the installer MSI file, the action file is located in this path ./.github/workflows/Release.yml, it runs when we draft a release in GitHub releases page. If you decide to fork the repository, this action is at your disposal. However, it's important to note that the action might encounter issues during execution. This is primarily due to a few steps that are tailored specifically to our proprietary update system. These steps involve uploading certain files to our FTP server and triggering a webhook that updates the version number within our update system's INI file.

To overcome this, you can simply omit these custom steps while retaining the remainder of the action. This will allow you to successfully obtain the installer file as an attachment in your GitHub release assets.

How to make a new release

Sure, here's a step-by-step guide on how to draft a new release on GitHub:

  1. Log In: Make sure you're logged into your GitHub account.

  2. Navigate to Your Repository: Go to the repository ( your fork repository ) where you want to create a new release.

  3. Click on "Releases": Once you're in your repository, navigate to the "Releases" from the the right sidebar.

Releases

  1. Click "Draft a New Release" Button: On the "Releases" page, you'll find a green "Draft a New Release" button. Click on it to start creating your new release.

Releases-·-temcocontrols-T3000_Building_Automation_System

  1. Tag Version: In the "Tag version" field, enter the version number for your release. This can be in any format you choose (e.g., v1.0.0, v20230823, etc.). This tag is used to mark the specific commit or branch that the release corresponds to.

  2. Release Title: Enter a title for your release. This title should be descriptive and give users an idea of what this release includes.

  3. Description: Write a detailed description of the release. This could include information such as new features, bug fixes, improvements, and any other relevant details. You can format this description using Markdown for better readability.

  4. Publishing: Choose whether you want to publish the release immediately or save it as a draft for now. If you're still working on it and want to make changes before making it public, choose "Save draft." Otherwise, if you're ready to make it public, choose "Publish release."

  5. Publish the Release: If everything looks good, click the "Publish release" button. This will make the release public and visible to others.

New-release-·-temcocontrols-T3000_Building_Automation_System

  1. View and Share: Once published, you can view the release on the "Releases" page of your repository. You'll find a URL for the release page that you can share with others.

And that's it! You've successfully drafted and published a new release on GitHub. Make sure to follow these steps carefully and double-check the information you provide to ensure accuracy.

Clone this wiki locally