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

Improve auth0_action docs #287

Merged
merged 2 commits into from
Aug 24, 2022
Merged

Improve auth0_action docs #287

merged 2 commits into from
Aug 24, 2022

Conversation

sergiught
Copy link
Contributor

@sergiught sergiught commented Aug 19, 2022

🔧 Changes

Small improvement to further clarify what the version stands for within actions.supported_triggers in order to help prevent issues like #286.

📚 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 self-assigned this Aug 19, 2022
@codecov-commenter
Copy link

codecov-commenter commented Aug 19, 2022

Codecov Report

Merging #287 (1e75c23) into main (7d8ba99) will not change coverage.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main     #287   +/-   ##
=======================================
  Coverage   85.23%   85.23%           
=======================================
  Files          39       39           
  Lines        8227     8227           
=======================================
  Hits         7012     7012           
  Misses        964      964           
  Partials      251      251           
Impacted Files Coverage Δ
internal/provider/resource_auth0_action.go 87.11% <100.00%> (ø)

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

@sergiught sergiught marked this pull request as ready for review August 19, 2022 15:54
@sergiught sergiught requested a review from a team as a code owner August 19, 2022 15:54
@@ -81,7 +81,7 @@ resource "auth0_action" "my_action" {
Required:

- `id` (String) The trigger ID.
- `version` (String) The trigger version.
Copy link
Contributor

Choose a reason for hiding this comment

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

This does not control the runtime, but it does regulate which runtimes are supported.

Make sure the version supports the desired node runtime

Is this actually actionable with our current documentation?

@willvedd
Copy link
Contributor

IMO, this is well intentioned, but not a final solution. I think we need to work with the relevant services to provide a more actionable error message and more documentation on the API-side.

@sergiught sergiught force-pushed the patch/docs-auth0-actions branch from aeeb852 to 89c7435 Compare August 19, 2022 16:02
@sergiught
Copy link
Contributor Author

Makes sense, let's just add this extra phrase then for now as a small improvement: This regulates which runtime versions are supported. and see what we can do internally. Wdyt?

@sergiught sergiught requested a review from willvedd August 19, 2022 16:08
@sergiught sergiught requested review from willvedd and removed request for willvedd August 24, 2022 10:13
@sergiught sergiught merged commit 2815a9a into main Aug 24, 2022
@sergiught sergiught deleted the patch/docs-auth0-actions branch August 24, 2022 12:57
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.

3 participants