Skip to content

Latest commit

 

History

History
63 lines (34 loc) · 1.94 KB

PUBLISH.md

File metadata and controls

63 lines (34 loc) · 1.94 KB

Guide-for-Emmie: How to publish a LEB-ToolBox update

This guide will walk you through the steps required to successfully publish to all LEB users a LEB-ToolBox update.

What is a LEB-ToolBox update?

A LEB-ToolBox update consist of 4 files: The Source Code (.py), the Windows build (.exe), and the Linux and MacOS (binary)

Things to know:

LEB-ToolBox update number scheme consists of a FLOAT type number. That is, a number with decimals. Updates must be named as follows:

A.BBB

A: main revision

B: sub revision

Unlike other name schemes, you cannot, for example, use the scheme A.B.C, as 1.2.3 isn't a decimal number (you can't just have two points in a decimal number bruh).

GitHub Structure Scheme

LEB-ToolBox.py ----- Required to fetch new versions

LEB-ToolBox-vA.B.exe ----- Windows Builds

LEB-ToolBox-vA.B ----- Linux Builds

LEB-ToolBox-vA.B-MacOS ----- MacOS Builds

Hypothetical Environment

Current version: 1.2 || Target version: 1.3

Step 1: Build your new binaries

To start, first you need to compile the binaries for your new version.

The values that need to be changed are:

cnt_program = 1.2 ----> cnt_program = 1.3

ver_info = "OLD CHANGELOG" ----> ver_info = "NEW CHANGELOG"

Once it has been patched, build the files.

The names of the files must be:

LEB-ToolBox-vA.B + OS specific extension

A and B are the version number

Step 2: Upload files

Now, you must upload all the binaries and the source code (.py) file. Be warned that the moment you upload the source code (.py) file, the version will be published instantly! If for whatever reason, you don't want to publish the update, change the cnt_program value.

Note that, starting from 1.3, you can skip binaries for some operating systems. A message will popup to the user telling them there isn't a build available at the time.``

You finished!

You can now test if your update is live by updating an old executable file.