Build and Deployment

After a new version of FUDGE is released, a build and deployment GitHub Action is triggered automatically. This action automates the process of building and deploying FUDGE. The workflow file for this action can be found in the repository under the .github/workflows folder.

Steps Overview

Here is a schematic overview of the steps involved in the build and deployment process:

1. Checkout Repository: The action starts by checking out the repository at the tag associated with the release event. This ensures that the build and deployment process is performed on the specific version of FUDGE corresponding to the release.

2. Install TypeScript and TypeDoc: The necessary TypeScript and TypeDoc versions are installed to ensure the correct dependencies are available for the build process.

3. Compile Source Files: The source files are compiled using the CompileAll.bat script located within the repository. This step ensures that the code is transformed into an executable format.

4. Bundle FUDGE Runtime: The required files from the repository are bundled into a FUDGE runtime folder. This includes the various components and resources necessary for running FUDGE.

5. Create fudge.zip: The fudge.zip file is created by compressing the contents of the FUDGE runtime folder. This zip file contains all the necessary files to run FUDGE.

6. Deploy FUDGE: The fudge.zip file is attached to the release that triggered the release event. This makes the deployment package available for users to download and use.