mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-03 17:48:59 +00:00
53 lines
2.0 KiB
Markdown
53 lines
2.0 KiB
Markdown
---
|
|
layout: page
|
|
title: "Maintenance"
|
|
description: "Steps involved to maintain the current state of Home Assistant."
|
|
date: 2016-09-13 17:00
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
---
|
|
|
|
This page documents a couple of points for maintaining the Home Assistant code. Most of the tasks don't need to be performed on a regular base thus the steps, used tools, or details are preserved here.
|
|
|
|
## {% linkable_title Source code %}
|
|
|
|
### {% linkable_title Line separator %}
|
|
|
|
People are using various operating systems to develop components and platforms for Home Assistant. This could lead to different line endings on file. We prefer `LN`. Especially Microsoft Windows tools tend to use `CRLF`.
|
|
|
|
```bash
|
|
$ find homeassistant -name "*.py" -exec file {} \; | grep BOM
|
|
$ find homeassistant -name "*.py" -exec file {} \; | grep CRLF
|
|
```
|
|
|
|
To fix the line separator, use `dos2unix` or `sed`.
|
|
|
|
```bash
|
|
$ dos2unix homeassistant/components/notify/kodi.py
|
|
```
|
|
|
|
### {% linkable_title File permissions %}
|
|
|
|
Most files don't need to the be executable. `0644` is fine.
|
|
|
|
### {% linkable_title Dependencies %}
|
|
|
|
A lot of components and platforms depends on third-party Python modules. The dependencies which are stored in the `requirements_*.txt` files are tracked by [gemnasium](https://gemnasium.com/github.com/home-assistant/home-assistant) and [Requires.io](https://requires.io/github/home-assistant/home-assistant/requirements/?branch=dev).
|
|
|
|
If you update the requirements of a component/platform through the `REQUIREMENTS = ['modules-xyz==0.3']` entry, run the provided script to update the `requirements_*.txt` file(s).
|
|
|
|
```bash
|
|
$ script/gen_requirements_all.py
|
|
```
|
|
|
|
Start a test run of Home Assistant. If that was successful, include all files in a Pull Request. Add a short summary of the changes, a sample configuration entry, details about the tests you performed to ensure the update works, and other useful information to the description.
|
|
|
|
|
|
## {% linkable_title Documentation %}
|
|
|
|
- Merge `current` into `next` on a regular base.
|
|
- Optimize the images.
|
|
|