mirror of
https://github.com/tgstation/tgstation-server.git
synced 2026-08-29 16:11:05 +01:00
Cleanup
This commit is contained in:
@@ -149,7 +149,32 @@ There is no strict process when it comes to merging pull requests. Pull requests
|
||||
|
||||
* Commits MUST be properly titled and commented as we only use merge commits for the pull request process
|
||||
|
||||
## Deployment process
|
||||
|
||||
Every issue/pull request in a release should share a common milestone named with the release version i.e. `4.5.3.5`
|
||||
|
||||
When every issue and PR in the milestone is closed. Create a version bump PR that changes the version numbers. At the time of this writing they exist in the following files
|
||||
|
||||
- `/src/Tgstation.Server.Host/Tgstation.Server.Host.csproj`
|
||||
- `/src/Tgstation.Server.Host.Console/Tgstation.Server.Host.Console.csproj`
|
||||
- 2 in `/src/Tgstation.Server.Host.Service/Properties/AssemblyInfo.cs`
|
||||
- `/src/Tgstation.Server.Host.Watchdog/Tgstation.Server.Host.Watchdog.csproj`
|
||||
|
||||
Merge the pull request with `[TGSDeploy]` somewhere in the commit title. The scripts will handle amalgamating release notes, building, closing the milestone, and publishing the release. This will also trigger update notifications on existing TGS deployments.
|
||||
|
||||
### API/Client Deployment
|
||||
|
||||
The Api/Client project versions must be updated on nuget when changed. The numbers exist in the following files:
|
||||
|
||||
- `/src/Tgstation.Server.Api/Tgstation.Server.Api.csproj`
|
||||
- `/src/Tgstation.Server.Client/Tgstation.Server.Client.csproj`
|
||||
|
||||
These should not be the same numbers as the main suite. When bumping the API version the client should only receive a minor (3rd number) version bump unless major changes to CLIENT code were made.
|
||||
|
||||
Merge these alongside regular deployments with `[NugetDeploy]` in the commit title (Won't work without an accompanying `[TGSDeploy]`). This will handle the nuget publishing.
|
||||
|
||||
## Banned content
|
||||
|
||||
Do not add any of the following in a Pull Request or risk getting the PR closed:
|
||||
* National Socialist Party of Germany content, National Socialist Party of Germany related content, or National Socialist Party of Germany references
|
||||
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
[Release Notes]: # (Your PR should contain a detailed list of notable changes, titled appropriately. This includes any observable changes to the server or DMAPI. See example below)
|
||||
|
||||
:cl:
|
||||
Description of your change
|
||||
Each newline corresponds to a release note in the upcoming sprint
|
||||
/:cl:
|
||||
|
||||
:cl:
|
||||
You can also have multiple sets of release notes per pull request
|
||||
They will be amalgamated together in the end
|
||||
/:cl:
|
||||
|
||||
[Why]: # (Please add a short description [two lines down] of why you think these changes would benefit the game. If you can't justify it in words, it might not be worth adding.)
|
||||
Reference in New Issue
Block a user