From 283041be8676b70a7bd650600bd19aa616c9c30b Mon Sep 17 00:00:00 2001 From: DrSmugleaf Date: Thu, 28 Sep 2023 01:43:32 -0700 Subject: [PATCH] Add doc documenting how to publish a new RobustToolbox version --- .../publishing-robusttoolbox.md | 22 +++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 src/en/robust-toolbox/publishing-robusttoolbox.md diff --git a/src/en/robust-toolbox/publishing-robusttoolbox.md b/src/en/robust-toolbox/publishing-robusttoolbox.md new file mode 100644 index 000000000..7fede3d10 --- /dev/null +++ b/src/en/robust-toolbox/publishing-robusttoolbox.md @@ -0,0 +1,22 @@ +# Publishing RobustToolbox + +```admonish info +These instructions are a step-by-step guide for engine maintainers to follow. +``` + +1. Open a terminal in the RobustToolbox directory (`cd RobustToolbox` if you are in the space-station-14 directory) +2. Checkout the master branch (`git checkout master`) +3. Update your master branch (`git pull https://github.com/space-wizards/RobustToolbox.git master`) +4. Run version.py (`python ./Tools/version.py 0.1.0`, where 0.1.0 is the version number you want, WITHOUT 'v') + - If you use `py` instead on Windows it might not work due to the python microsoft store alias. +5. Push your commit and tag to RobustToolbox (`git push` and `git push https://github.com/space-wizards/RobustToolbox.git v0.1.0`, WITH 'v') + - Do NOT run `git push --tags` as that will push every tag you have locally, even those that have been deleted. +6. Go back into the content directory (`cd ..`) +7. Checkout a new branch (`git checkout -b update/robust-0.1.0`) +8. Push your branch (`git push`) +9. Open a PR to the content repository and merge it. + +```admonish warning +It is always a good idea to run the game with the new engine version before publishing it and merging the PR, to check that everything still works. +You can also run tests locally as that will be faster than waiting for them to run on the GitHub workflows. +```