Skip to content

Home

Jump to bottom
Marc-Olivier Arsenault edited this page Aug 30, 2024 · 9 revisions

Dev Doc

Welcome to the DEV DOC for moonraker-home-assistant wiki!

This is mostly documentation for us as dev. For any user documentation, please refer to https://moonraker-home-assistant.readthedocs.io/en/latest/index.html

Create Release

  1. Open branch and set the new version
  2. upgrade using bumpversion by using: bumpversion patch, bumpversion minor or bumpversion major
  3. Push for PR
  4. Once Merged, open a GitHub Release
  5. Make Github create a new tag (based on new Version number)
  6. Title the release with same version number
  7. Add release notes

Generate doc locally

  1. In VS code
  2. Start web server (Launch live preview: Start Server) You only need to do this once (every time you start VS code)
  3. Compile doc (task/Generate Documentation) Re-run this command every time you modify the docs source code
  4. Click link http://127.0.0.1:3000/docs/_build/index.html in the terminal

module 'urllib3.util' has no attribute 'PROTOCOL_TLS'

If you get this error [module 'urllib3.util' has no attribute 'PROTOCOL_TLS'](https://github.com/home-assistant/core/issues/95192#top) simply manually update the urllib3 package pip install --upgrade urllib3

Clone this wiki locally