Skip to content

Remove fortigate integration#34586

Merged
frenck merged 3 commits intohome-assistant:devfrom
kifeo:fortigate-removal
Jun 23, 2020
Merged

Remove fortigate integration#34586
frenck merged 3 commits intohome-assistant:devfrom
kifeo:fortigate-removal

Conversation

@kifeo
Copy link
Copy Markdown
Contributor

@kifeo kifeo commented Apr 23, 2020

Breaking change

The forigate integration has been removed in favor of the foritos integration.

Proposed change

remove the fortigate intgration

as stated in #32057, I will use fortios integration instead to only have one fortinet related integration.

removed the fortigate integration :

  1. rm -Rf /homeassistant/components/fortigate
  2. removed the entry in requirements_all.txt

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:

  • Documentation added/updated

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

@frenck
Copy link
Copy Markdown
Member

frenck commented Apr 23, 2020

Shouldn't this be deprecated first?
Documentation PR is missing.

@kifeo
Copy link
Copy Markdown
Contributor Author

kifeo commented Apr 23, 2020

sorry @frenck, how do I deprecate ?
I'll delete the doc PR later.

@kifeo
Copy link
Copy Markdown
Contributor Author

kifeo commented Apr 28, 2020

added deprecation patch in home-assistant/home-assistant.io#13197

Copy link
Copy Markdown
Member

@MartinHjelmare MartinHjelmare left a comment

Choose a reason for hiding this comment

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

Please also update .coveragerc:

homeassistant/components/fortigate/*

@MartinHjelmare
Copy link
Copy Markdown
Member

But, yeah, deprecation is preferred, so do that instead if possible. ☺

@MartinHjelmare
Copy link
Copy Markdown
Member

MartinHjelmare commented Apr 28, 2020

Log a warning message when setting up the integration, telling the user why it's deprecated and when it'll be removed.

It's also possible to use our deprecated config validator:

@kifeo
Copy link
Copy Markdown
Contributor Author

kifeo commented Apr 29, 2020

@MartinHjelmare "when it'll be removed"
Is it ok if I put in the next major release ? or will it be two minor release ?

I'll create another PR for the deprecation

@MartinHjelmare
Copy link
Copy Markdown
Member

Right now our standard time for deprecation is two minor releases, ie 6 weeks.

@kifeo
Copy link
Copy Markdown
Contributor Author

kifeo commented Apr 29, 2020

I could add the cv.deprecated, but this is only for every config setting, not the integration itself, is there a global deprecation function ?

@MartinHjelmare
Copy link
Copy Markdown
Member

MartinHjelmare commented Apr 29, 2020

We would wrap the DOMAIN key with cv.deprecated inside a vol.All that wraps both that and the domain schema.

CONFIG_SCHEMA = vol.Schema(
    vol.All(
        cv.deprecated(DOMAIN),
        {DOMAIN: vol.Schema(...)},
    ),
    extra=vol.ALLOW_EXTRA,
)

@kifeo
Copy link
Copy Markdown
Contributor Author

kifeo commented Apr 29, 2020

Thank you, I added the PR #34854 to warn about the deprecation first

@stale
Copy link
Copy Markdown

stale Bot commented Jun 3, 2020

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days.
Thank you for your contributions.

@stale stale Bot added the stale label Jun 3, 2020
@MartinHjelmare
Copy link
Copy Markdown
Member

We can merge this now that the beta for 0.111.0 is cut. This PR will go out in 0.112.0.

Please make a PR to the docs next branch removing the pages for the integration. Check with the docs team for further instructions.

When we have a docs PR linked here we can merge.

@stale stale Bot removed the stale label Jun 3, 2020
Comment thread .coveragerc Outdated
@kifeo
Copy link
Copy Markdown
Contributor Author

kifeo commented Jun 4, 2020

doc PR : home-assistant/home-assistant.io#13662

@frenck
Copy link
Copy Markdown
Member

frenck commented Jun 4, 2020

@kifeo The only thing left right now, I think, is to rebase this PR in order to resolve the merge conflicts it currently has.

kifeo added 3 commits June 4, 2020 15:20
removed the fortigate intgration
removed the fortigate intgration
@frenck frenck merged commit 2af9615 into home-assistant:dev Jun 23, 2020
@lock lock Bot locked and limited conversation to collaborators Jun 24, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants