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

ESD-25205: Deprecate enabled_clients on the auth0_connection resource #421

Merged
merged 1 commit into from
Dec 20, 2022

Conversation

sergiught
Copy link
Contributor

@sergiught sergiught commented Dec 20, 2022

🔧 Changes

The issue surfaced through #416 is caused by the fact that we allow for 2 ways of managing enabled_clients on 2 separate resources that affect the planning phase of the terraform process.

This is similar to what we experienced when we had the auth0_organization.connections and auth0_organization_connection resource, where we ended up keeping just the latter.

So we're deprecating the use of enabled_clients through the auth0_connection resource in favor of the auth0_connection_client resource.

📚 References

🔬 Testing

📝 Checklist

  • All new/changed/fixed functionality is covered by tests (or N/A)
  • I have added documentation for all new/changed functionality (or N/A)

@sergiught sergiught force-pushed the patch/ESD-25205-enabled_clients branch 2 times, most recently from f04219a to 17d8077 Compare December 20, 2022 12:13
@codecov-commenter
Copy link

Codecov Report

Base: 86.80% // Head: 86.80% // Decreases project coverage by -0.00% ⚠️

Coverage data is based on head (17d8077) compared to base (3ca221f).
Patch has no changes to coverable lines.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #421      +/-   ##
==========================================
- Coverage   86.80%   86.80%   -0.01%     
==========================================
  Files          41       41              
  Lines        9040     9038       -2     
==========================================
- Hits         7847     7845       -2     
  Misses        924      924              
  Partials      269      269              
Impacted Files Coverage Δ
internal/provider/resource_auth0_connection.go 72.83% <ø> (-0.17%) ⬇️
internal/provider/structure_auth0_connection.go 90.42% <ø> (-0.01%) ⬇️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@sergiught sergiught marked this pull request as ready for review December 20, 2022 12:34
@sergiught sergiught requested a review from a team as a code owner December 20, 2022 12:34
@sergiught sergiught force-pushed the patch/ESD-25205-enabled_clients branch from 17d8077 to 92b90e5 Compare December 20, 2022 15:35
@willvedd
Copy link
Contributor

**Update: ** Instead of deprecating, we're just opting to remove the problematic field altogether. Either way users will need to migrate to the resource, a breaking change just communicates that in a stronger way than deprecation. Once we've graduated from v0 we'll be more methodical about deprecations and maintaining backwards compatibility.

Copy link
Contributor

@willvedd willvedd left a comment

Choose a reason for hiding this comment

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

Sergiu and I looked at this together, we've decided to remove the deprecation label and instead just remove the functionality outright. It'll make for a quicker migration for all involved IMO.

@sergiught sergiught merged commit d9ffca1 into main Dec 20, 2022
@sergiught sergiught deleted the patch/ESD-25205-enabled_clients branch December 20, 2022 15:54
@perplexa
Copy link

perplexa commented Jan 6, 2023

it would be nice to have some deprecation notice next time for people who are using this provider in production environments.

@maxime-gaudron
Copy link

@willvedd When will the provider reach v1 tho? it wasn't a great surprise this morning :)

@roblframpton
Copy link

Does this repo not use semantic versioning? This breaking change caused us some difficulty when our CI started failing due to the interface change but our local workspaces were fine, and we'd like to avoid that in the future.

@sergiught
Copy link
Contributor Author

Hey @roblframpton 👋🏻

Thanks for taking the time to express this painpoint. We understand how crucial stability and predictability are in software development, and we regret any disruptions you experienced.

To clarify the situation, up until now, we have been operating on version v0 of the provider, and during v0, we are not strictly bound by semver rules. The v0 indicates that our API is not yet considered stable and as a result, we might introduce breaking changes without following semver convetions.

However, we want to assure you that we have been closely monitoring the feedback from users like you, and we recognize the importance of adhering to industry standard versioning practices for better compatibility and predictability moving forward. So because of this we are excited to announce that we have recently released the v1.0.0-beta.0 and from the moment we launch the GA version v1.0.0 on we are committed to strictly adhering to semantic versioning principles. We encourage you to try out this new version and start planning your migration to v1.0.0. Please rest assured that moving forward, we will ensure compatibility and gradual updates in line with semver guidelines.

If you encounter any issues or have any questions during the migration process, we are more than willing to provide assitance and support to smoothen the transition.

Thanks for your understanding and continued support!


📚 Resources

Quickstart | Documentation | Migration Guide | Changelog

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants