Merge branch 'main' into add-linkcheck-ci

.github/workflows/add-to-project.yml

@@ -0,0 +1,16 @@
+name: add-to-project
+
+on:
+  issues:
+    types:
+      - opened
+
+jobs:
+  add-to-project:
+    name: Add to project
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/[email protected]
+        with:
+          project-url: "https://github.com/orgs/R2Northstar/projects/3"
+          github-token: "${{ secrets.PROJECT_BOARD_TOKEN }}"

docs/SUMMARY.md

@@ -47,18 +47,19 @@
 ## Modding and Development
 
 * [Modding](modding/README.md)
-* [Development](modding-and-development/development/README.md)
-  * [Repositories](modding-and-development/development/repositories/README.md)
-    * [Atlas](modding-and-development/development/repositories/atlas.md)
-    * [NorthstarMods](modding-and-development/development/repositories/northstarmods.md)
-    * [NorthstarLauncher](modding-and-development/development/northstarlauncher.md)
-    * [NorthstarMasterServer (old)](modding-and-development/development/northstarmasterserver/README.md)
-      * [Deploy](modding-and-development/development/northstarmasterserver/deploy.md)
-  * [Contributing code to Northstar](modding-and-development/development/contributing-code-to-northstar.md)
-  * [Testing](modding-and-development/testing.md)
-  * [Reviewing](modding-and-development/development/reviewing.md)
-  * [Releases](modding-and-development/development/releases.md)
+* [Development](development/README.md)
+  * [Repositories](development/repositories/README.md)
+    * [Atlas](development/repositories/atlas.md)
+    * [NorthstarMods](development/repositories/northstarmods.md)
+    * [NorthstarLauncher](development/northstarlauncher.md)
+    * [NorthstarMasterServer (old)](development/northstarmasterserver/README.md)
+      * [Deploy](development/northstarmasterserver/deploy.md)
+  * [Contributing code to Northstar](development/contributing-code-to-northstar.md)
+  * [Testing](development/testing.md)
+  * [Reviewing](development/reviewing.md)
+  * [Releases](development/releases.md)
 
 ## Other
 
+* [Discord moderation](other/moderation.md)
 * [Credits](other/credits.md)

docs/contributing.md

@@ -12,4 +12,4 @@ Read [CONTRIBUTING.md](https://github.com/R2Northstar/Northstar/blob/main/CONTRI
 Please remember that issues created in the Northstar repositories should be related to the mod, avoid creating issues asking for tech support or problems unrelated to the project.
 {% endhint %}
 
-Check the [Development](modding-and-development/development/README.md) section if you are unsure of where to open a ticket.
+Check the [Development](development/README.md) section if you are unsure of where to open a ticket.

docs/modding-and-development/development/northstarmasterserver/README.md → docs/development/northstarmasterserver/README.md

@@ -8,7 +8,7 @@ The old NodeJS master server has been replaced in favour of the Go rewrite calle
 
 The master server is responsible for centralizing game servers created by players, it also verifies that connecting players own an Origin account with Titanfall 2.
 
-There's no need to host your own master server to play games with other people, you can use [direct connect](../../../using-northstar/direct-connect.md) or just setup a [normal server](../../../hosting-a-server-with-northstar/basic-listen-server.md) that announces itself to `northstar.tf`. This tutorial is aimed for those who want to contribute improvements to the code or test their own changes to the project.
+There's no need to host your own master server to play games with other people, you can use [direct connect](../../using-northstar/direct-connect.md) or just setup a [normal server](../../hosting-a-server-with-northstar/basic-listen-server.md) that announces itself to `northstar.tf`. This tutorial is aimed for those who want to contribute improvements to the code or test their own changes to the project.
 
 ## Contents
 

docs/development/releases.md

@@ -0,0 +1,141 @@
+---
+description: >-
+  Information intended mostly for internal use on what to consider when making
+  new releases
+---
+
+# Releases
+
+{% hint style="info" %}
+WIP
+{% endhint %}
+
+## General
+
+CI on Northstar release repo builds versioned release if tag is pushed. It checks Launcher and Mods for the same tag.
+It then downloads the related build for Launcher from releases and the Squirrel related source files from the mods repo.
+It then combines the files together with DiscordRPC and navmeshes to build the final release. \
+Therefore make sure to push tags of Mods and Launcher first (and make sure Launcher has finished building).
+
+CI also pushes release directly to Thunderstore as a mod called [`Northstar`](https://northstar.thunderstore.io/package/northstar/Northstar/). \
+If it's a release-candidate with the `-rcX` suffix, it will instead get pushed to Thunderstore as [`NorthstarReleaseCandidate`](https://northstar.thunderstore.io/package/northstar/NorthstarReleaseCandidate/).
+
+### The process of making a release:
+
+The following is a rough draft of the steps needed to make a release.
+The process is ever changing in order to simplify it so these steps outlined might not be up-to-date anymore depending on when you are reading this.
+
+The current process of making release (includinging release candidate) is:
+
+1. Make release branch (`MAJOR.MINOR.X`) (if not exists)
+
+2. Merge desired commits from `main`
+    - Make sure to consider whether changing are breaking in regards to older/newer server/client and in regards to Squirrel API.
+      - Older/newer client/server breakage might need to be version gated and should **NOT** be done in patch releases.
+      - Squirrel API changes likely breaks mods and should **NOT** be done in patch releases. Additionaly make sure to ping modders on release or preferably even in advance.
+    - If changes can be merged fast-forward use `git merge --ff-only origin/main` otherwise cherry-pick relevant commits.
+
+3. Make release candidate\
+   Push tags ending in `-rcX` where `X` is integer for
+    1. Launcher
+    2. Mods
+    3. Release (wait until launcher has finished building)
+
+4. Make draft notes\
+   You can use FlightCore to generate them and then format them manually.\
+   If you use FlightCore make sure to remove already released commits if they were cherry-picked.
+
+5. Create a draft discussion in [release repo discussions](https://github.com/R2Northstar/Northstar/discussions)
+
+6. Make related github-org thread and link the draft notes there for feedback etc
+
+7. Ping playtesters to test release candidate.
+    1. Add information about what specific aspect to test.
+    2. Copy relevant changes for this release candidate from draft release notes.
+    3. Link draft release notes.
+    4. Make thread to leave feedback about release in.
+
+8. Wait until release candidate was sufficiently tested.
+
+9. Make release
+   Push tags for
+    1. Launcher
+    2. Mods
+    3. Release (wait until launcher has finished building)
+
+10. Once release has finished building
+    1. Go to GitHub release and select the new unpublished release
+    2. Copy release notes from draft.
+    3. Click checkbox for creating discussion and select _Release_ as category
+    4. Publish
+
+11. Post announcements on Discord
+    1. Post message in `#server-hosting-announcements` channel.\
+       Make sure to highlight server hosting specific changes.\
+       Make thread for bug reports.
+    2. Post message in `#modding-announcements`.\
+       Make sure to highlight modding specific changes (API changes etc).
+    3. Post message in `#announcements`.\
+       Make sure to highlight end-user specific changes (new features, certainn fixes, etc).
+
+
+12. Update main menu promos version on Atlas
+
+13. Push Docker image
+    1. Get SHA512 checksum of zip from release CI
+    2. Make PR to [Docker repo](https://github.com/pg9182/northstar-dedicated) to update Docker image to newest Northstar release
+    3. Merge PR
+    4. Wait for Docker repo CI to finish
+    5. Approve image
+
+14. Observe version roll-out via [Grafana dashboard](https://northstar-stats.frontier.tf/).
+
+### Git commands for tags:
+
+**For release candidates:**
+
+```
+git tag vX.Y.Z-rcN
+git push origin vX.Y.Z-rcN
+```
+
+Example:
+
+```
+git tag v1.8.0-rc1
+git push origin v1.8.0-rc1
+```
+
+**For actual releases**
+
+```
+git tag vX.Y.Z
+git push origin vX.Y.Z
+```
+
+Example:
+
+```
+git tag v1.8.0
+git push origin v1.8.0
+```
+
+## Version numbering
+
+In general, Northstar tries to follow [semantic versioning](https://semver.org/). This means version numbers are `MAJOR.MINOR.PATCH`, where
+
+- `MAJOR` is updated for breaking changes
+- `MINOR` is updated for changes that are backwards compatible
+- `PATCH` is updated for fixes that are backwards compatible
+
+Semantic versioning is however not followed exactly. For example, to ship out smaller features faster they have been included in patch releases. Similarly, there have been smaller breaking changes, yet at the time of writing the major version number so far has never been updated.
+
+The reason for this is mostly due to player expectations. Players expect the change from `1.0` to `2.0` to be big. As such, the plan for the near future is to update the major version, once we have a bigger feature ready to release that brings us closer to vanilla in terms of missing features (e.g. _Frontier Defense_).
+
+Once `2.0` has been released, expectations for `3.0` tend to be lower as the number is no longer "doubled". Past `3.0`, proper semver can probably be employed without hampering player expectations.
+
+
+## Best practices:
+
+- Make at least one release candidate and test it before actual release.
+- Release should also only ever be latest release candidate but tagged as release to avoid introducing new bugs.

docs/modding-and-development/development/reviewing.md → docs/development/reviewing.md

@@ -19,15 +19,15 @@ It's not necessary to do both when reviewing as long as you mention what you did
 
 For code review head to the _"Files changed"_ section of the PR.
 
-![](../../.gitbook/assets/review1.png)
+![](../.gitbook/assets/review1.png)
 
 From there you can select the line(s) you want to leave a comment on.
 
-![](../../.gitbook/assets/review2.PNG)
+![](../.gitbook/assets/review2.PNG)
 
 Type in your comment and click on _"Start a review"_.
 
-![](../../.gitbook/assets/review3.png)
+![](../.gitbook/assets/review3.png)
 
 Note that this will **NOT** post your comment immediately! Add any remaining comments to other lines of code, then head to the _Finishing up_ section of this wiki page to see how to post your code review.
 
@@ -38,7 +38,7 @@ Note that this will **NOT** post your comment immediately! Add any remaining com
 For testing a PR, refer to the following page
 
 {% content-ref url="../testing.md" %}
-[testing.md](../testing.md)
+[testing.md](./testing.md)
 {% endcontent-ref %}
 
 The TL;DR is to test the aspect that has been changed.
@@ -47,7 +47,7 @@ The TL;DR is to test the aspect that has been changed.
 
 After you performed the testing and/or code review leave a final comment by clicking on _"Finish your review"_ on the top right of the _"Files changed"_ page of the PR.
 
-![](../../.gitbook/assets/review4.png)
+![](../.gitbook/assets/review4.png)
 
 In your final comment make sure to mention what you did, e.g. which aspects of the change you tested for or what you considered during code review (formatting, edge cases, ...). The more detailed this part is the easier it is for other reviewers to tell which aspects they can skip during reviewing to speed up the process.
 

docs/modding-and-development/testing.md → docs/development/testing.md

@@ -55,7 +55,7 @@ Before starting, make sure you have a **working and up-to-date Northstar install
     ![rcon4](https://user-images.githubusercontent.com/40122905/179727511-877641f8-e5fc-4a34-bcf1-29bafefc1ad2.png)
 5. Once downloaded, open the zip and copy `Northstar.dll` and `NorthstarLauncher.exe` to your Titanfall2 folder, overwriting the existing DLL and EXE in there.
 
-Alternatively, compiling the PR'd code from source is also an option. For this, refer to [northstarlauncher.md](development/northstarlauncher.md "mention")
+Alternatively, compiling the PR'd code from source is also an option. For this, refer to [northstarlauncher.md](northstarlauncher.md "mention")
 
 #### NorthstarMods
 

docs/hosting-a-server-with-northstar/dedicated-server/best-practices.md

@@ -17,7 +17,7 @@ The current minimum requirements are as follows:
 - 5GB free disk space (+3 GB if you're on windows due to origin and deps)
 - 3+ cores (2 might work, though)
 - 3GB+ total memory (RAM or swap will do)
-- Windows 8.1 (and built-in WARP [use `-softwared3d11`] or a graphics card) + or wine 6.0.0+ (and dxvk+lavapipe+x11, wined3d+llvmpipe+x11, or a working graphics setup with dxvk or llvmpipe) (see [this](https://github.com/pg9182/northstar-dedicated) for more)
+- Windows 8.1 (and built-in WARP \[use `-softwared3d11`\] or a graphics card) + or wine 6.0.0+ (and dxvk+lavapipe+x11, wined3d+llvmpipe+x11, or a working graphics setup with dxvk or llvmpipe) (see [this](https://github.com/pg9182/northstar-dedicated) for more)
 
 **Per instance:**