Skip to content

SquadJS v3.0.0 Release
Compare
Choose a tag to compare
@Thomas-Smyth Thomas-Smyth released this 07 Mar 17:47
· 326 commits to master since this release
v3.0.0
54af956

About

This major version bump to SquadJS v3.0.0 was made to signify our new release and version number policy taking effect and to draw a line under the previous poor management of releases and version numbers.

The policy, as was at the time of release, can be found below.

Versions and Releases

Whilst installing SquadJS you may do the following to obtain slightly different versions:

  • Download the latest release - To get the latest stable version of SquadJS.
  • Download/clone the master branch - To get the most up to date version of SquadJS.

All changes proposed to SquadJS will be merged into the master branch prior to being released in the next stable version to allow for a period of larger-scale testing to occur. Therefore, we only recommend individuals who are willing to update regularly and partake in testing/bug reporting use the master branch. Please note, updates to the master branch will not be advertised in the SquadJS startup information, however, notifications of merged pull requests into the master branch may be found in our Discord. Once the master branch is deemed stable a release will be published and advertised via the SquadJS startup information and our Discord.

Releases will be given a version number with the format v{major}.{minor}.{patch}, e.g. v3.1.4. Changes to {major}/{minor}/{patch} will imply the following:

  • {major} - The release contains a new/updated feature that is (potentially) breaking, e.g. changes to event outputs that may cause custom plugins to break.
  • {minor} - The release contains a new/updated feature.
  • {patch} - The release contains a bug fix.

Please note, {minor}/{patch} releases may still break SquadJS installations, however, this may be prevented with configuration changes and should not require custom plugins to be updated.

Release version numbers and changelogs are managed by Release Drafter which relies on the appropriate labels being applied to pull requests. Version numbers are updated in the package.json file manually prior to publishing the release draft.

The above policy was written and put into effect after the release of SquadJS v2.0.5. A major version bump to SquadJS v3.0.0 was made to signify this policy taking effect and to draw a line under the previous poor management of releases and version numbers.

Assets 2
Loading