Skip to content

Conversation

daroga0002
Copy link
Contributor

This pull request focuses on improving code clarity, documentation, and maintainability for the Tech Controllers Home Assistant integration. The main changes include updating workflow dependencies, enhancing docstrings for better developer understanding, refactoring asset utilities, and making minor code improvements for consistency.

Workflow and Dependency Updates:

  • Added a new .github/dependabot.yaml configuration to automate dependency updates for GitHub Actions.
  • Updated GitHub Actions workflows to use the latest versions of actions/checkout and actions/setup-python for improved reliability and security. [1] [2] [3] [4]

Code Documentation and Clarity:

  • Enhanced and standardized docstrings across integration entry points and entity classes (e.g., custom_components/tech/__init__.py, binary_sensor.py, climate.py, and config_flow.py) to clarify function purposes, arguments, and return values for easier onboarding and maintenance. [1] [2] [3] [4] [5] [6] [7]

Asset Utilities Refactor:

  • Refactored custom_components/tech/assets.py to improve type safety, update docstrings, introduce a constant for redacted values, and clarify translation and icon lookup logic. This makes asset handling more robust and easier to extend.

Minor Codebase Improvements:

  • Updated the pre-commit configuration to use a newer version of Ruff and switched to the ruff-check hook for auto-fixing linter issues.
  • Improved argument imports and formatting for consistency in config_flow.py.

These changes collectively enhance the integration’s reliability, developer experience, and future maintainability.

@anarion80 anarion80 added chore Maintenance activities patch labels Oct 2, 2025
@daroga0002
Copy link
Contributor Author

@anarion80 addition of dependabot config for github actions will also require adding two GitHub labels for this repo (if not existing):

  • dependencies
  • github-actions

Then Dependabot will automatically label those changes on PRs

@anarion80
Copy link
Collaborator

  • dependencies

I tried adding Dependabot before: 39f2610 but then it turned out that to enable it on the repo one needs to set appropriate settings: https://docs.github.com/en/code-security/getting-started/dependabot-quickstart-guide#enabling-dependabot-for-your-repository for which I don't have access. And I decided not to bother Mariusz to do that :)

@daroga0002
Copy link
Contributor Author

hmm, yup it will be problem :/

This integration has some number of users which are using it actively in their Home Assistant setup. Maybe we can consider moving this code to separate organization (the best path will be official transferring repo there). GitHub is currently allowing to create organization for free with all features (in case of public repos) https://github.com/organizations/plan

So then potentially we can have even few admins/contributors taking care of this codebase and have management priviliges of repo/organization what will cause we will be able have redundancy around it.

License is MIT so technically we can just fork/copy repo but I would rather avoid this as we building some trust around users.

@mariusz-ostoja-swierczynski does you will be willing to transfer this repo to separate organization to allow future development without bothering you around any repo setup or etc.??

PS
I have just reserved https://github.com/orgs/tech-controllers just in case if in this discussion we decide to go with this path. So I can give/pass admin to anybody interested in this org.

@daroga0002
Copy link
Contributor Author

@anarion80 I opened new issue to follow up topic above
#161

Regarding dependabot config, even if this is not enabled we can just merge (then it will be not working probably here, but will be propagated to Forks) or I can just remove it.

I have running this code for few days with L-X Wifi controller and didnt found any issues. I also performed some testing using test account from Tech Sterowniki and also didnt observed any issues so can you take a look and if everything will be ok then merge?

@anarion80 anarion80 merged commit d0094da into mariusz-ostoja-swierczynski:main Oct 3, 2025
3 checks passed
@daroga0002 daroga0002 deleted the small-refactor branch October 6, 2025 06:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

chore Maintenance activities patch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants