build/README.md

# SPT Build Project - CI/CD Process

This document outlines the Continuous Integration and Continuous Deployment (CI/CD) setup for the `SPT-AKI/Build` project, which automates the build and release process for three interconnected repositories: `SPT-AKI/Modules`, `SPT-AKI/Server`, and `SPT-AKI/Launcher`. The process is orchestrated using Gitea Actions.

## Project Repositories

TODO: Update for Gitea

~~Each of the three project repositories (`SPT-AKI/Modules`, `SPT-AKI/Server`, `SPT-AKI/Launcher`) requires a `.drone.yml` file configured to trigger a build in this `SPT-AKI/Build` repository using the Drone downstream plugin upon a new tag push (e.g., `v3.8.0`). The contents of the `.drone.yml` file can be found in `project-trigger.yml`. Note that the file must be present and named `.drone.yml` to trigger the build process.~~

### Build Process

This repository initiates the CI/CD build process by performing the following actions:

1. Checks if the passed in tag exists in all three project repositories.
1. Clones the tagged commits of each repository.
1. Builds each project.
1. Combines and compresses the build files into a release file.
1. Copies the release file to web-accessible locations.
1. Sends release notifications.

## Module Requirements

To build the Modules project, a link to a private repository is required for the build process. The link is stored as a secret in the Drone CI/CD environment. The secret is named `MODULE_DOMAIN` and is used to download files from the private repository. It does not end with a slash.

## Building the Docker Images

Be sure to update the version number to the next available version before building and pushing the Docker images. you must be logged into Docker Desktop to push the images.

```
# Build and push the spt-build-node Docker image to the Docker Hub
docker build -t refringe/spt-build-node:1.0.7 -t refringe/spt-build-node:latest -f Dockerfile.node .
docker push refringe/spt-build-node --all-tags

# Build and push the spt-build-dotnet Docker image to the Docker Hub
docker build -t refringe/spt-build-dotnet:1.0.1 -t refringe/spt-build-dotnet:latest -f Dockerfile.dotnet .
docker push refringe/spt-build-dotnet --all-tags
```
Build Scripts Got to a point where the server and modules are being compiled correctly. Launcher script needs... something. It's failing to build and I don't know why. TODO: - Fix Launcher Build Script - Combine sub-builds into output directory - Compress output directory - Upload release to public folder - Adapt build script to work with a dynamic tag value - Update script to only run _any_ builds when the tag exists in all three - Write drone configuration version of the dockerfile/script - Testing within the Drone env 2024-02-14 01:35:01 -05:00			`# SPT Build Project - CI/CD Process`

Changes Include: - Adds missing static files - Adds build step to combine and decompress artifacts - Removes some older drone references 2024-03-05 23:05:43 -05:00			This document outlines the Continuous Integration and Continuous Deployment (CI/CD) setup for the `SPT-AKI/Build` project, which automates the build and release process for three interconnected repositories: `SPT-AKI/Modules`, `SPT-AKI/Server`, and `SPT-AKI/Launcher`. The process is orchestrated using Gitea Actions.
Build Scripts Got to a point where the server and modules are being compiled correctly. Launcher script needs... something. It's failing to build and I don't know why. TODO: - Fix Launcher Build Script - Combine sub-builds into output directory - Compress output directory - Upload release to public folder - Adapt build script to work with a dynamic tag value - Update script to only run _any_ builds when the tag exists in all three - Write drone configuration version of the dockerfile/script - Testing within the Drone env 2024-02-14 01:35:01 -05:00
			`## Project Repositories`

Changes Include: - Adds missing static files - Adds build step to combine and decompress artifacts - Removes some older drone references 2024-03-05 23:05:43 -05:00			`TODO: Update for Gitea`

Updates README 2024-03-26 11:09:15 -04:00			~~Each of the three project repositories (`SPT-AKI/Modules`, `SPT-AKI/Server`, `SPT-AKI/Launcher`) requires a `.drone.yml` file configured to trigger a build in this `SPT-AKI/Build` repository using the Drone downstream plugin upon a new tag push (e.g., `v3.8.0`). The contents of the `.drone.yml` file can be found in `project-trigger.yml`. Note that the file must be present and named `.drone.yml` to trigger the build process.~~
Build Scripts Got to a point where the server and modules are being compiled correctly. Launcher script needs... something. It's failing to build and I don't know why. TODO: - Fix Launcher Build Script - Combine sub-builds into output directory - Compress output directory - Upload release to public folder - Adapt build script to work with a dynamic tag value - Update script to only run _any_ builds when the tag exists in all three - Write drone configuration version of the dockerfile/script - Testing within the Drone env 2024-02-14 01:35:01 -05:00
			`### Build Process`

Changes Include: - Adds missing static files - Adds build step to combine and decompress artifacts - Removes some older drone references 2024-03-05 23:05:43 -05:00			`This repository initiates the CI/CD build process by performing the following actions:`
Build Scripts Got to a point where the server and modules are being compiled correctly. Launcher script needs... something. It's failing to build and I don't know why. TODO: - Fix Launcher Build Script - Combine sub-builds into output directory - Compress output directory - Upload release to public folder - Adapt build script to work with a dynamic tag value - Update script to only run _any_ builds when the tag exists in all three - Write drone configuration version of the dockerfile/script - Testing within the Drone env 2024-02-14 01:35:01 -05:00
			`1. Checks if the passed in tag exists in all three project repositories.`
			`1. Clones the tagged commits of each repository.`
			`1. Builds each project.`
			`1. Combines and compresses the build files into a release file.`
Updates README 2024-03-26 11:09:15 -04:00			`1. Copies the release file to web-accessible locations.`
			`1. Sends release notifications.`
Build Scripts Got to a point where the server and modules are being compiled correctly. Launcher script needs... something. It's failing to build and I don't know why. TODO: - Fix Launcher Build Script - Combine sub-builds into output directory - Compress output directory - Upload release to public folder - Adapt build script to work with a dynamic tag value - Update script to only run _any_ builds when the tag exists in all three - Write drone configuration version of the dockerfile/script - Testing within the Drone env 2024-02-14 01:35:01 -05:00
			`## Module Requirements`

Add client module package download step 2024-03-03 18:29:54 -05:00			To build the Modules project, a link to a private repository is required for the build process. The link is stored as a secret in the Drone CI/CD environment. The secret is named `MODULE_DOMAIN` and is used to download files from the private repository. It does not end with a slash.
Build Scripts Got to a point where the server and modules are being compiled correctly. Launcher script needs... something. It's failing to build and I don't know why. TODO: - Fix Launcher Build Script - Combine sub-builds into output directory - Compress output directory - Upload release to public folder - Adapt build script to work with a dynamic tag value - Update script to only run _any_ builds when the tag exists in all three - Write drone configuration version of the dockerfile/script - Testing within the Drone env 2024-02-14 01:35:01 -05:00
Update Dockerfile.dotnet to include jq package and update README.md with build and push commands for Docker images 2024-03-03 13:38:03 -05:00			`## Building the Docker Images`
Build Scripts Got to a point where the server and modules are being compiled correctly. Launcher script needs... something. It's failing to build and I don't know why. TODO: - Fix Launcher Build Script - Combine sub-builds into output directory - Compress output directory - Upload release to public folder - Adapt build script to work with a dynamic tag value - Update script to only run _any_ builds when the tag exists in all three - Write drone configuration version of the dockerfile/script - Testing within the Drone env 2024-02-14 01:35:01 -05:00
Update Dockerfile.dotnet to include jq package and update README.md with build and push commands for Docker images 2024-03-03 13:38:03 -05:00			`Be sure to update the version number to the next available version before building and pushing the Docker images. you must be logged into Docker Desktop to push the images.`
Build Scripts Got to a point where the server and modules are being compiled correctly. Launcher script needs... something. It's failing to build and I don't know why. TODO: - Fix Launcher Build Script - Combine sub-builds into output directory - Compress output directory - Upload release to public folder - Adapt build script to work with a dynamic tag value - Update script to only run _any_ builds when the tag exists in all three - Write drone configuration version of the dockerfile/script - Testing within the Drone env 2024-02-14 01:35:01 -05:00
Update Dockerfile.dotnet to include jq package and update README.md with build and push commands for Docker images 2024-03-03 13:38:03 -05:00			```
Back to two docker images; one for dotnet, one for node. 2024-03-08 12:21:08 -05:00			`# Build and push the spt-build-node Docker image to the Docker Hub`
Updates! - Nightly builds should happen at 3pm ET - The Determine-Build-Type step happens earlier in the build process now & it's based on the passed tag instead of the current commits tag. - Torrent files are only created for stable releases. - Nightly builds are now cleaned from external sources - External sources now delete nightly, debug, and bleeding releases older than 14 days. - Updates node environment to v20.11.1 2024-03-14 17:27:16 -04:00			`docker build -t refringe/spt-build-node:1.0.7 -t refringe/spt-build-node:latest -f Dockerfile.node .`
Back to two docker images; one for dotnet, one for node. 2024-03-08 12:21:08 -05:00			`docker push refringe/spt-build-node --all-tags`
Build Scripts Got to a point where the server and modules are being compiled correctly. Launcher script needs... something. It's failing to build and I don't know why. TODO: - Fix Launcher Build Script - Combine sub-builds into output directory - Compress output directory - Upload release to public folder - Adapt build script to work with a dynamic tag value - Update script to only run _any_ builds when the tag exists in all three - Write drone configuration version of the dockerfile/script - Testing within the Drone env 2024-02-14 01:35:01 -05:00
Back to two docker images; one for dotnet, one for node. 2024-03-08 12:21:08 -05:00			`# Build and push the spt-build-dotnet Docker image to the Docker Hub`
Updates the clean HTTPS source step to use LFTP. No terminal access. :( 2024-03-09 14:27:29 -05:00			`docker build -t refringe/spt-build-dotnet:1.0.1 -t refringe/spt-build-dotnet:latest -f Dockerfile.dotnet .`
Back to two docker images; one for dotnet, one for node. 2024-03-08 12:21:08 -05:00			`docker push refringe/spt-build-dotnet --all-tags`
Build Scripts Got to a point where the server and modules are being compiled correctly. Launcher script needs... something. It's failing to build and I don't know why. TODO: - Fix Launcher Build Script - Combine sub-builds into output directory - Compress output directory - Upload release to public folder - Adapt build script to work with a dynamic tag value - Update script to only run _any_ builds when the tag exists in all three - Write drone configuration version of the dockerfile/script - Testing within the Drone env 2024-02-14 01:35:01 -05:00			```