Skip to content

Compare: Library Maintainers Guide

Showing with 23 additions and 1 deletion.
  1. +23 −1 Library-Maintainers-Guide.md
24 changes: 23 additions & 1 deletion Library-Maintainers-Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,18 @@ $ make run_tests
```

## New version release checklist
1. `git checkout master; git pull` Make sure your _master_ branch is up-to-date
1. Make sure your _master_ branch is up-to-date.
- i.e. `git fetch; git checkout master; git pull`
1. Update/Re-generate the Doxygen API documentation pages.
1. Install [doxygen](https://www.doxygen.nl/index.html) if you haven't already.
1. In the root of the project, run the command `doxygen`
- If there is no output from the command, all went well! Huzzah.
- If there are errors or warnings, fix/address them (in the normal PR manor) before proceeding.
1. Perform the following commands:
```shell
$ git commit -a -m "Regenerate Doxygen documentation"
$ git push
```
1. `git checkout -b vXX.YY.ZZ` Where vXX.YY.ZZ is the new version string. e.g. _v2.3.2_
1. Change the library version in the code:
1. Update `_IRREMOTEESP8266_VERSION_` in `src/IRremoteESP8266.h` to the new version number.
Expand Down Expand Up @@ -160,5 +171,16 @@ $ make run_tests
1. Click the _Preview_ tab and check it looks okay.
1. _Publish Release_
1. The new release is now **live**. Arduino IDE's Library Manager should pick up the new version within 24 hours.
1. Publish the documentation (e.g. API docs) to Github Pages.
- Perform the following commands:
```shell
$ git fetch; git checkout master; git pull
$ git checkout gh-pages
$ git pull
$ git merge -s subtree master
$ git push
```
- The documentation should now be live at: https://crankyoldgit.github.io/IRremoteESP8266/
- API documentation: https://crankyoldgit.github.io/IRremoteESP8266/doxygen/html/
1. Update any reported bugs that were fixed by changes that happened between this new version and the now previous one.
1. Relax. Grab a cold beverage. It's all done.