Skip to content

Conversation

@dikhan
Copy link
Owner

@dikhan dikhan commented Nov 13, 2021

What problem does this Pull Request solve?

Please link to the issue number here (issue will be closed when PR is merged): Closes #318

More context:

  • After deep evaluation as to whether supporting a new version of the Schema config would make sense, the final conclusion was that the overhead incurred to support multiple versions would not pay off since the goal was to eliminate this functionality all together considering it's no longer providing any value preventing users from switching between different provider versions across different terraform projects that may pin to different versions of this provider. Hence, maintaining support for two parallel configurations in this case would result into unpredictable behaviours with users using SchemaV1 which is not desired.
  • Nevertheless, since this changeset updates the contract of a public interface with a non backwards compatible change this change set will be released under a new major version.

Type of change

What type of change does your code introduce to the provider? Please put an x (w/o heading/trailing white spaces) in the boxes that apply:

  • New feature (change that adds new functionality)
  • Bug-fix (change that fixes current functionality)
  • Tech debt (enhances the current functionality)
  • New release (pumps the version)

Checklist

Please put an x (w/o heading/trailing white spaces) in the boxes that apply:

  • I have read and followed the CONTRIBUTING guidelines
  • I have added tests that prove my fix is effective or that my feature works
  • I have made sure code compiles correctly and all tests are passing by running make test-all
  • I have added/updated necessary documentation (if appropriate)
  • I have added the following info to the title of the PR (pick the appropriate option for the type of change). This is important because the release notes will include this information.
    • Feature Request: PRs related to feature requests should have in the title [FeatureRequest: Issue #X] <PR Title>
    • Bug Fixes: PRs related to bug fixes should have in the title [BugFix: Issue #X] <PR Title>
    • Tech Debt: PRs related to technical debt should have in the title [TechDebt: Issue #X] <PR Title>
    • New Release: PRs related to a new release should have in the title [NewRelease] vX.Y.Z

Checklist for Admins

  • Label is populated
  • PR is assigned to the corresponding project
  • PR has at least 1 reviewer and 1 assignee

@codecov
Copy link

codecov bot commented Nov 13, 2021

Codecov Report

Merging #319 (0059a55) into master (594a891) will increase coverage by 0.09%.
The diff coverage is 66.66%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #319      +/-   ##
==========================================
+ Coverage   93.56%   93.66%   +0.09%     
==========================================
  Files          60       60              
  Lines        3591     3584       -7     
==========================================
- Hits         3360     3357       -3     
+ Misses        163      160       -3     
+ Partials       68       67       -1     
Impacted Files Coverage Δ
openapi/plugin_config_schema.go 92.00% <ø> (ø)
openapi/plugin_config_services_stub.go 90.00% <0.00%> (+8.18%) ⬆️
openapi/terraformutils/terraform_utils.go 79.36% <ø> (ø)
openapi/plugin_config.go 75.00% <100.00%> (+2.77%) ⬆️
openapi/plugin_config_services.go 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 594a891...0059a55. Read the comment docs.

@dikhan dikhan force-pushed the deprecate-plugin-version-config branch from 5c969dc to 30d7138 Compare December 24, 2021 01:43
@dikhan dikhan force-pushed the deprecate-plugin-version-config branch 2 times, most recently from ed1e38b to 9f75cba Compare January 21, 2022 15:59
- After deep evaluation as to whether supporting a new version of the Schema config would make sense, the final conclusion was that the overhead incurred to support multiple versions would not pay off since the goal was to eliminate this functionality all together considering it's no longer providing any value preventing users from switching between different provider versions across different projects. Hence, maintaining support for two parallel configurations in this case would result into unpredictable behaviours with users using SchemaV1 which is not desired.
- Nevertheless, since this changeset updates the contract of a public interface with a non backwards compatible change this change set will be released under a new major version.
@dikhan dikhan force-pushed the deprecate-plugin-version-config branch from 9f75cba to 0059a55 Compare January 22, 2022 05:03
@dikhan
Copy link
Owner Author

dikhan commented Jan 22, 2022

Reviewed code coverage report and acknowledging the lack of coverage for this particular line. The current method the way it is makes it difficult to test certain inner calls but to be able to add that coverage would involve having a major refactoring of the code which is not in the scope for this card. Code coverage remains equal to how it was before in that file and where possible coverage has been incremented in other places.

@dikhan dikhan merged commit f10e3fc into master Jan 22, 2022
@dikhan dikhan deleted the deprecate-plugin-version-config branch January 22, 2022 05:22
@dikhan dikhan mentioned this pull request Apr 18, 2022
16 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Deprecate plugin_version functionality

2 participants