-
Notifications
You must be signed in to change notification settings - Fork 54
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into hosting-on-windows
- Loading branch information
Showing
45 changed files
with
389 additions
and
114 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "ignorePatterns": [ | ||
| { | ||
| "pattern": "https://help.ea.com/en/help/pc/link-ea-and-steam/" | ||
| } | ||
| ] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 }}" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| name: Linkcheck | ||
| on: [push, pull_request] | ||
|
|
||
| jobs: | ||
| markdown-link-check: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v3 | ||
| - name: md-linkcheck | ||
| uses: gaurav-nelson/github-action-markdown-link-check@v1 | ||
| with: | ||
| use-quiet-mode: 'yes' | ||
| config-file: '.github/.markdownlinkcheck.json' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| book |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| # This file configures `mdbook` which is used for rendering wiki locally | ||
| # See the main README.md for more info | ||
|
|
||
| [book] | ||
| language = "en" | ||
| multilingual = false | ||
| src = "docs" | ||
| title = "Northstar Wiki" | ||
|
|
||
| [output.html] | ||
|
|
||
| [output.linkcheck] | ||
| optional = true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| # Debugging | ||
|
|
||
| {% hint style="warning" %} | ||
| Debugging Northstar is only recommended to experienced developers. | ||
| If you need help figuring out an issue feel free to visit the Northstar Discord. | ||
| {% endhint %} | ||
|
|
||
| ## Contents | ||
| * [Visual Studio](visualstudio.md) | ||
| * [x64dbg](x64dbg.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| # Visual Studio | ||
|
|
||
| Northstar is easiest to debug through Visual Studio due to its cmake support. | ||
|
|
||
|
|
||
| * If you do not already have Visual Studio download it https://visualstudio.microsoft.com/ | ||
| * Its recommended that you install the Community version because it is freely availalbe. | ||
| * You need to install the `Desktop development with C++` workflow to debug native programs | ||
|  | ||
|
|
||
| * Open Visual Studio | ||
| * Select `Open a project or solution` | ||
|  | ||
| * If you already have a solution open you can open a new project through the menu bar | ||
|  | ||
| * Open `NorthstarLauncher.exe` | ||
| * You can now debug Northstar | ||
|  | ||
| * You can find relevant debug symbols in [NorthstarLauncher releases](https://github.com/R2Northstar/NorthstarLauncher/releases) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| # x64dbg | ||
|
|
||
| {% hint style="warning" %} | ||
| If you are not experienced with x64dbg it its recommended to use [Visual Studio](visualstudio.md). | ||
| {% endhint %} | ||
|
|
||
|
|
||
| ## Windows | ||
|
|
||
| * Download [x64dbg](https://x64dbg.com/) | ||
| * Extract the `release` folder somewhere on your PC | ||
| * Download the latest relase of [SycllaHide](https://github.com/x64dbg/ScyllaHide/releases/latest) | ||
| * Merge the contents of the `x64dbg` folder into the previously extracted `release` folder | ||
| * Run `x96dbg.exe` | ||
| * You may receive a Windows SmartScreen prompt, x64dbg snapshots are not signed and will always cause these prompts | ||
| * When running for the first time it will ask you some questions. After this is complete rerun the executable. | ||
| * Select `x64dbg` in the Launcher | ||
|  | ||
|
|
||
| * Do make debugging easier it is suggested to change your settings to the following: | ||
| * Keeping System Breakpoint enabled is optional but useful | ||
|  | ||
|
|
||
| * Skipping INT3 stepping is recommended to prevent generic breakpoints from stopping the program | ||
|  | ||
|
|
||
| * Make sure to select the exception before disabling breaking. If you are debugging a C++ Exception you need to ignore common exceptions that occur during runtime | ||
|  | ||
|
|
||
| * Open `NorthstarLauncher.exe` in x64dbg | ||
| * You are now free to debug Northstar | ||
|
|
||
| ## Linux | ||
|
|
||
| {% hint style="warning" %} | ||
| Debugging Northstar under Linux is not trivial due to the direct dependency on Origin, unless you know your way around wine its recommended to debug on Windows. | ||
| {% endhint %} | ||
|
|
||
| To simplify the use of x64dbg and automate running Origin a community member has created a script: [ns-linux-dbg](https://github.com/R2NorthstarTools/ns-linux-dbg) | ||
|
|
||
| To run it simply invoke it: `./nsdbg.py` | ||
| It supports a variety of options as well as vanilla wine and Proton, use the help flag to see all possible options: `./nsdbg.py --help` |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. |
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.