Deprecate sensors in Habitica integration

[tr4nt0r]

Breaking change

Breaking change in the future

Proposed change

Deprecates 3 sensors:

• Max. Health:: The max. health is 50 for all players and cannot be altered..
• Habits and Rewards: All rewards and habits are dumped as JSON into the extra state attributes of these sensors, which is considered bad practice. The state of the sensors displays the total count of habits/rewards, but this kind of tasks is set up once and they don't get marked as completed or deleted upon completion, so the total count is almost always unchanged. As alternative way to retrieve task data a service action has been proposed: Add get_tasks action to Habitica integration #127687

Type of change

• Dependency upgrade
• Bugfix (non-breaking change which fixes an issue)
• New integration (thank you!)
• New feature (which adds functionality to an existing integration)
• Deprecation (breaking change to happen in the future)
• Breaking change (fix/feature causing existing functionality to break)
• Code quality improvements to existing code or addition of tests

Additional information

• This PR fixes or closes issue: fixes #
• This PR is related to issue:
• Link to documentation pull request:

Checklist

• The code change is tested and works locally.
• Local tests pass. Your PR cannot be merged unless tests pass
• There is no commented out code in this PR.
• I have followed the development checklist
• I have followed the perfect PR recommendations
• The code has been formatted using Ruff (ruff format homeassistant tests)
• Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

• Documentation added/updated for www.home-assistant.io

If the code communicates with devices, web services, or third-party tools:

• The manifest file has all fields filled out correctly.
  Updated and included derived files by running: python3 -m script.hassfest.
• New or updated dependencies have been added to requirements_all.txt.
  Updated by running python3 -m script.gen_requirements_all.
• For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.

To help with the load of incoming pull requests:

• I have reviewed two other open pull requests in this repository.

[gjohansson-ST]

Even better, do not add these entities if they are disabled (or did not exist already)

[gjohansson-ST]

I think we should move this to setup_entry and combine with my previous comment.

[home-assistant]

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.