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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add data entry flow show progress step #42419

Merged
merged 8 commits into from Nov 9, 2020

Conversation

MartinHjelmare
Copy link
Member

@MartinHjelmare MartinHjelmare commented Oct 26, 2020

Breaking change

Proposed change

  • Add a helper step that should show progress to the user and finish when a task is done.
  • This step is similar to the external step, but doesn't take a url as parameter.
  • This step is useful when a task takes long time (minutes) and we want to inform the user about this.
  • We'll use this step in the upcoming extension of the ozw config flow.

TODO

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)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Example entry for configuration.yaml:

# Example configuration.yaml

Additional information

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

The integration reached or maintains the following Integration Quality Scale:

  • No score or internal
  • 馃 Silver
  • 馃 Gold
  • 馃弳 Platinum

To help with the load of incoming pull requests:

Dev automation moved this from Needs review to Reviewer approved Oct 30, 2020
Copy link
Member

@balloob balloob left a comment

Choose a reason for hiding this comment

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

Looks good. One update to the test needed to make sure that we can update the progress_action.

@MartinHjelmare MartinHjelmare changed the title Add data entry flow info step Add data entry flow show progress helper Nov 2, 2020
@MartinHjelmare MartinHjelmare changed the title Add data entry flow show progress helper Add data entry flow show progress step Nov 2, 2020
@MartinHjelmare
Copy link
Member Author

Should we wait for the frontend PR to be opened before merge here?

@balloob
Copy link
Member

balloob commented Nov 2, 2020

Yeah, that makes sense.

@ludeeus
Copy link
Member

ludeeus commented Nov 4, 2020

Should this be documented?

@MartinHjelmare
Copy link
Member Author

Yes!

@MartinHjelmare
Copy link
Member Author

Let's put the docs on the data entry page. This is a general step so not specific for config flows.

I can make the docs PR.

@MartinHjelmare MartinHjelmare marked this pull request as ready for review November 9, 2020 14:12
@MartinHjelmare MartinHjelmare merged commit 1338c4a into dev Nov 9, 2020
Dev automation moved this from Reviewer approved to Done Nov 9, 2020
@MartinHjelmare MartinHjelmare deleted the add-data_entry_flow-info-step branch November 9, 2020 17:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Dev
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

4 participants