Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate timer start optional duration parameter #93471

Conversation

gjohansson-ST
Copy link
Member

@gjohansson-ST gjohansson-ST commented May 24, 2023

Proposed change

Start deprecation of optional duration parameter for start service call (changes configuration).

It brings this integration in a weird place, where the configuration is overridden and stored/restored based on state restore; overriding YAML and the storage.

Also done for other similar helpers, example #93343

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 Black (black --fast homeassistant tests)
  • Tests have been added to verify that the new code works.

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

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.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

@home-assistant home-assistant bot added cla-signed core deprecation Indicates a breaking change to happen in the future integration: timer small-pr PRs with less than 30 lines. Quality Scale: internal labels May 24, 2023
Copy link
Contributor

@emontnemery emontnemery left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please link to where it was decided to remove the duration parameter or provide the rationale in the PR description

homeassistant/components/timer/strings.json Outdated Show resolved Hide resolved
@home-assistant
Copy link

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.

@home-assistant home-assistant bot marked this pull request as draft May 25, 2023 09:01
@gjohansson-ST gjohansson-ST marked this pull request as ready for review May 25, 2023 11:54
@home-assistant home-assistant bot requested a review from emontnemery May 25, 2023 11:54
Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a merge conflict, could you take a look?

@gjohansson-ST gjohansson-ST force-pushed the depr-timer-start-service-duration-param branch from e421970 to 36a4763 Compare June 2, 2023 15:29
@gjohansson-ST
Copy link
Member Author

@frenck Conflicts fixed

@gjohansson-ST gjohansson-ST reopened this Jun 3, 2023
@gjohansson-ST gjohansson-ST requested a review from frenck June 3, 2023 18:25
@gjohansson-ST gjohansson-ST force-pushed the depr-timer-start-service-duration-param branch from 65e1a7c to 9bd83c9 Compare July 9, 2023 12:02
@gjohansson-ST gjohansson-ST force-pushed the depr-timer-start-service-duration-param branch from 9a47fef to fc83cc8 Compare July 19, 2023 17:15
@gjohansson-ST gjohansson-ST force-pushed the depr-timer-start-service-duration-param branch from fc83cc8 to bf5107f Compare July 27, 2023 13:43
@gjohansson-ST gjohansson-ST added the smash Indicator this PR is close to finish for merging or closing label Jul 27, 2023
@gjohansson-ST gjohansson-ST force-pushed the depr-timer-start-service-duration-param branch from 3aafbf9 to 61654a1 Compare August 18, 2023 12:39
Copy link
Contributor

@emontnemery emontnemery left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks @gjohansson-ST 👍

@gjohansson-ST gjohansson-ST merged commit 2ce5b08 into home-assistant:dev Aug 30, 2023
34 checks passed
@gjohansson-ST gjohansson-ST deleted the depr-timer-start-service-duration-param branch August 30, 2023 09:48
@github-actions github-actions bot locked and limited conversation to collaborators Aug 31, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
cla-signed core deprecation Indicates a breaking change to happen in the future integration: timer Quality Scale: internal small-pr PRs with less than 30 lines. smash Indicator this PR is close to finish for merging or closing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants