Project Template

From Railway Operation Simulator Wiki
Revision as of 21:40, 3 December 2022 by Krizar (talk | contribs) (Started template page)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

The GitHub Organisation contains a repository for constructing projects/add-ons for the simulator using the Git version control system. The template provides the standardised project format directory structure, and configuration files for running GitHub actions Continuous Integration on the project files.

Continuous Integration and Deployment

Release

It is recommended that a release be made when the project is passed testing, to do this create a GitHub release for the repository giving a tag name a valid semantic version (e.g. this would usually be `v1.0.0` for the first version). Doing this triggers the automatic deployment pipeline which creates a package of the files required for users to run your simulation, this package follows the standard package form and can be uploaded to the RailOS website.