FastLED Release howto

Pushing a fastled release, the short version, last updated May 2024

Example

Edit these files to update the version number

Edit this file with release notes and version number.

Release notes should list highlight changes (not necessarily all minor bug fixes) and thank people for their help.

Git commands to commit and tag release'

bash

$ git commit -am "Rev 3.10.3"
$ git tag 3.10.3 master
$ git push
$ git push origin 3.10.3

Then use the GitHub UI to make a new “Release”:

Announce new version on subreddit, highlighting major changes and thanking people for helping.

That's it.

Before starting the version update, ensure release_notes.md has an entry for the new version at the top of the file with:

Update the version number in the following files:

Three places need updating:

Line ~20: #define FASTLED_VERSION 3010003 (format: XYYYZZZZ where X=major, YYY=minor, ZZZ=patch)
Line ~24: #pragma message "FastLED version 3.010.003"
Line ~26: #warning FastLED version 3.010.003 (Not really a warning, just telling you here.)

bash

$ git add -A
$ git commit -m "Rev 3.10.3"

bash

$ git tag 3.10.3 master

At this point halt with the message to tell the user to do the following steps:

bash

$ git push
$ git push origin 3.10.3

Post on the FastLED subreddit (r/FastLED) with: