Skip to content

Commit 3641323

Browse files
committed
Bump version, deployment notes
1 parent 4422d5d commit 3641323

File tree

2 files changed

+27
-1
lines changed

2 files changed

+27
-1
lines changed

DEPLOYMENT.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Deployment
2+
3+
A [GitHub Action](https://github.com/satisfactorymodding/SatisfactoryModManager/blob/master/.github/workflows/push.yml)
4+
automatically creates testing builds from commits on any branch and uploads them to the run as build artifacts.
5+
6+
## Development Builds
7+
8+
Since the build action is triggered on every push to any branch,
9+
non developers can obtain testing builds easily from [GitHub Actions](https://github.com/satisfactorymodding/SatisfactoryModManager/actions/workflows/push.yml) artifact output.
10+
You need to be signed into GitHub to download them, and they expire after some time.
11+
12+
TODO how to point dev builds to ficsit.dev (staging) instead?
13+
14+
## Releases
15+
16+
To create a new published release:
17+
18+
1. Ensure all intended changes are merged into the `master` branch.
19+
2. Make a `Bump version` commit on the master branch to increase the `productVersion` field in `wails.json`. Version numbers should follow [Semantic Versioning](https://semver.org/).
20+
3. Manually create and push a tag of the format `v*` to that commit, which triggers a [GitHub Action to make a release](https://github.com/satisfactorymodding/SatisfactoryModManager/blob/master/.github/workflows/release.yml).
21+
4. Have someone on the Satisfactory Modding team with Signpath access approve the release.
22+
At the time of writing, that's Vilsol and Mircea.
23+
5. Review the draft release automatically created by Goreleaser and edit its description as needed.
24+
6. Publish the release.
25+
26+
Users will automatically be prompted to update next time they launch SMM.

wails.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
"email": "mircearoatapalade@gmail.com"
1313
},
1414
"info": {
15-
"productVersion": "3.0.3",
15+
"productVersion": "3.0.4",
1616
"fileAssociations": [
1717
{
1818
"ext": "smmprofile",

0 commit comments

Comments
 (0)