Library Maintainers Guide

Jump to bottom

David Conran edited this page Mar 2, 2018 · 28 revisions

Library Maintainers Guide & Notes.

New version release checklist

git checkout master; git pull Make sure your master branch is up-to-date
git checkout -b vXX.YY.ZZ Where vXX.YY.ZZ is the new version string. e.g. v2.3.2
Change the library version in the code:
1. Update _IRREMOTEESP8266_VERSION_ in src/IRremoteESP8266.h to the new version number.
2. Update version in library.json & version= in library.properties accordingly.
3. All three must be the same.
Update the version information in the documentation:
1. Update "Now Available" section in README.md.
2. Update ReleaseNotes.md and add a new section for the new release.
  - git log should show you the change history.
  - Update the date to today's date for the new release.
Run tools/mkkeywords > keywords.txt from the top directory. (Requires a Linux machine etc)
git diff and review the changes are what you expect.
git commit -a and create an appropriate entry. e.g. "v2.3.2 release"
git push --set-upstream origin vXX.YY.ZZ
Wait for the Travis build to complete successfully.
Create a Pull Request to the 'master' branch:
- Set appropriate reviewers as needed.
- Copy in the new section of the ReleaseNotes.md as the PR comment.
Wait for:
1. Approval (or not, all the substantial commits should have already been done)
2. Travis to pass
3. Only then, merge to master.
Go to the Releases tab in github.
1. Click "Draft a new release".
2. Tag Version: vXX.YY.ZZ
3. Target: Master
4. Release title: IRremoteESP8266
5. Notes: Cut & paste from the ReleaseNotes.md update.
6. Make sure the pre-release checkbox is un-checked.
7. Click the Preview tab and check it looks okay.
8. Publish Release
The new release is now live. Arduino IDE's Library Manager should pick up the new version within 24 hours.
Update any reported bugs that were fixed by changes that happened between this new version and the now previous one.
Relax. Grab a cold beverage. It's all done.