Skip to content

Latest commit

 

History

History
38 lines (28 loc) · 2.16 KB

process.md

File metadata and controls

38 lines (28 loc) · 2.16 KB
Raw

OpenEVSE Process Documentation

Change management

Change requests and bug reports are are submitted through the GitHub issue tracker. There should be a single issue/bug/feature per ticket.

All changes should be made on a branch or fork of the master branch and the change should be submitted through a GitHub pull request. Pull requests will be reviewed by a repository administrator before being merged into the master branch. For changes by a repository administrator, the pull request should be reviewed by another administrator before being merging.

Building

Instructions on building the firmware an be found in the Developer Guide.

For releases and PR approval the builds are built using the Build/Release OpenEVSE workflow to ensure consistent behaviour.

Testing

TODO

Creating a new Releases

  1. Ensure GitHub actions are complete and green Build/Release OpenEVSE
  2. Create a new GitHub release entering the tag name as the new version number, for example: v1.0.0
  3. Add the release notes, a good start is to use the Auto-Generated Release Notes and edit as needed
  4. Select the Pre-release checkbox
  5. Click Publish release
  6. The GitHub build workflow will generate the binaries and upload them to the release
  7. Remove any unwanted binaries, need at least:
    • olimex_esp32-gateway-e.bin
    • adafruit_huzzah32.bin
    • openevse_wifi_v1.bin
    • espressif_esp-wrover-kit
    • nodemcu-32s
  8. Test the uploaded binaries
  9. Unselect the Pre-release checkbox
  10. Click Update release
  11. Ensure the release validation action is green Release Validation