Update Frames

Updating is usually easy, but some times, it requires a few extra steps.

First

Upgrade the Frames library version.

To do it, go to the buildSrc/src/main/java/Versions.kt file.

Then look for these lines:

const val frames = "x.x.x"

Update the version code with the latest, which currently is: (ignore the v character)

Next

The following steps are to apply some more specific or complex changes that are required every now and then to keep the apps completely up to date.

This might be a bit overwhelming at first, but once you get used to it, it will become easier.

The first thing you need to do, is check what version of Frames are you currently using and which one is the latest.

Let's say you are currently at version 2.3.0 and the latest is 2.3.7.

You must go version by version like: 2.3.1, then 2.3.2, then 2.3.3, and so forth, until you get to 2.3.7.

If you don't see a version listed below, for example 2.3.1, then it means no additional changes are required for that specific version, and you can move on with the next one, which would be 2.3.2.

Check below for the additional required changes. They usually have a link to a commit or a comparison, that looks like the following:

Some things to note:

• Red means code that was removed.
• Green means code that was added.
• Always, the whole line will be highlighted, but it doesn't mean the whole line was removed/added. And you might find small parts of the code in a line being highlighted with a darker color.

If you still need help, you can always join the discord server and ask any questions you have or ask for help.

---

Additional required changes:

Whenever a new release is available and it requires extra changes for your setup, this is the section where they will be mentioned.

Frames 3.6.1

Copy all the changes from this commit

Frames 3.6.0

Copy all the changes from this commit

Frames 3.5.8

Copy all the changes from this commit

Frames 3.5.7

Copy all the changes from this commit

Frames 3.5.6

Copy all the changes from this commit

Frames 3.5.5

Copy all the changes from this commit.

The new files in assets are just for sample purposes. Feel free to ignore them or not include them.

Frames 3.5.1

Copy all the changes from this commit.

And make sure to update the Gradle configuration in Android Studio like this:

Frames 3.5.0

Copy all the changes from these commits.

Frames 3.4.9

We found an error in this release and therefore removed it. If youʼre updating from version 3.4.8 or older, skip version 3.4.9 entirely and see above for how to update to version 3.5.0. If you updated to version 3.4.9 while it was available, we recommend you update to version 3.5.0. See above for how to do so, but keep in mind that youʼve already applied most of the changes required. Youʼll only have to change Versions.kt.

Frames 3.4.8

Copy all changes from this commit.

Frames 3.4.7

Copy all changes from this commit.

Frames 3.4.6

Copy all changes from this commit. You can ignore the changes in the .idea folder.

Frames 3.4.5

Copy all changes from this commit.

Frames 3.4.4

Copy all changes from this commit.

Frames 3.4.3

Copy all changes from this commit.

Frames 3.4.2

Copy all changes from this comparison.

Frames 3.3.7

Copy all changes from this commit.

Frames 3.3.5

Copy all changes from this commit.

Frames 3.3.4

Copy all changes from this commit.

Frames 3.3.3

Copy all changes from this commit.

Frames 3.3.1

Copy all changes from this commit.

Frames 3.2.1

Copy all changes from this commit.

Frames 3.1.3

Copy all changes from this commit.

Frames 3.1.2:

Review the settings in /app/src/main/res/values/dashboard_setup.xml.

Frames 3.0.4

Copy all changes from the following commits: 1, 2, 3.

Archive

If youʼre using Frames 2, see here for how to update. We recommend you switch to Frames 3.