Skip to content

Commit

Permalink
docs: Add beta versions page
Browse files Browse the repository at this point in the history
  • Loading branch information
3urobeat committed Feb 1, 2025
1 parent 4a146ac commit 67b882e
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/wiki/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ Are you rather searching for the developer documentation? [Click here to get red
- [Integrating into your own application](./integrating_into_your_app.md)
- [Creating plugins](./creating_plugins.md)
- [Contributing to the project](./contributing.md)
- [Beta Versions](./beta_versions.md)
- [Version Changelogs](./version_changelogs.md)

 
Expand All @@ -33,4 +34,4 @@ Discord: @3urobeat

 

> Steam Comment Service Bot - Created with ❤️ and a lot of time.
> Steam Comment Service Bot - Created with ❤️ and a lot of time.
32 changes: 32 additions & 0 deletions docs/wiki/beta_versions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Beta Versions
[⬅️ Go back to wiki home](./#readme)

 

The project is actively being developed on the [beta-testing](https://github.com/3urobeat/steam-comment-service-bot/tree/beta-testing) branch.
Whenever a state of the project is determined as being stable, a new version will be merged to the [master](https://github.com/3urobeat/steam-comment-service-bot/tree/master) branch, which includes all the new changes made on the beta-testing branch.

The bot uses the master branch to check for updates by default.
You can however also opt into getting beta updates.
These versions are unfinished and may contain unstable changes, but you can report any issues you find to support the development.

 

## Switching update channel
The branch to fetch updates from is set in [src/data/data.json](../../src/data/data.json).

To use the master branch, edit these values to look like this:
```
"branch": "master",
"filetostarturl": "https://raw.githubusercontent.com/3urobeat/steam-comment-service-bot/master/src/starter.js",
```

To use the beta-testing branch, edit these values to look like this:
```
"branch": "beta-testing",
"filetostarturl": "https://raw.githubusercontent.com/3urobeat/steam-comment-service-bot/beta-testing/src/starter.js",
```

Save the file and (re)start the bot.
It should now automatically update to the latest version available on the branch set.
If the currently installed version is the same as on the other (now set) branch, no update will be performed.

0 comments on commit 67b882e

Please sign in to comment.