Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add instructions for publishing a new RobustToolbox version #60

Merged
merged 6 commits into from
Sep 29, 2023
Merged

Add instructions for publishing a new RobustToolbox version #60

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
283041b
Add doc documenting how to publish a new RobustToolbox version
DrSmugleaf Sep 28, 2023
4879958
Add commit engine change step
DrSmugleaf Sep 28, 2023
8ad2569
Replace checkout and pull with fetch and checkout force
DrSmugleaf Sep 28, 2023
6fdfb32
Specify capital B on checkout
DrSmugleaf Sep 28, 2023
6ed34fe
Specify command to run tests locally
DrSmugleaf Sep 28, 2023
899ac5b
Add to summary.md
DrSmugleaf Sep 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ Robust Toolbox
- [Build Configurations](en/robust-toolbox/build-configurations.md)
- [Preprocessor Defines](en/robust-toolbox/preprocessor-defines.md)
- [MIDI](en/robust-toolbox/midi.md)
- [Publishing a new version](en/robust-toolbox/publishing-robusttoolbox.md)

Space Station 14
================
Expand Down
24 changes: 24 additions & 0 deletions src/en/robust-toolbox/publishing-robusttoolbox.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# 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. Fetch latest master (`git fetch https://github.com/space-wizards/RobustToolbox.git`)
3. Checkout the remote master branch (`git checkout -B master upstream/master`, WITH capital 'B' to overwrite master)
- This step will overwrite your local `master` branch with the remote one.
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. Commit the engine change (`git commit RobustToolbox -m "Update RobustToolbox"`)
9. Push your branch (`git push`)
10. 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 with "dotnet test" as that will be faster than waiting for them to run on the GitHub workflows.
```