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

[BugFix: Issue #265] Add deterministic order for resources and data sources rendered with the OpenAPI Terraform Documentation Renderer #267

Merged
merged 4 commits into from
Sep 18, 2020

Conversation

dikhan
Copy link
Owner

@dikhan dikhan commented Sep 12, 2020

What problem does this Pull Request solve?

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

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

@dikhan dikhan added the bug-fix label Sep 12, 2020
@dikhan dikhan requested a review from lillchan September 12, 2020 19:09
@dikhan dikhan self-assigned this Sep 12, 2020
@codecov
Copy link

codecov bot commented Sep 12, 2020

Codecov Report

Merging #267 into master will increase coverage by 0.02%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #267      +/-   ##
==========================================
+ Coverage   91.85%   91.87%   +0.02%     
==========================================
  Files          61       61              
  Lines        3611     3620       +9     
==========================================
+ Hits         3317     3326       +9     
  Misses        199      199              
  Partials       95       95              
Impacted Files Coverage Δ
...erator/openapi_terraform_provider_doc_generator.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 5b14e52...2409874. Read the comment docs.

Copy link
Collaborator

@lillchan lillchan left a comment

Choose a reason for hiding this comment

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

@dikhan I noticed the ordering in the example html changed, so I added a re-rendered version to this PR. I tried rendering the example ~5 times and the order didn't change, so looks good to me. Feel free to merge if that last commit looks ok.

@dikhan
Copy link
Owner Author

dikhan commented Sep 18, 2020

Good call @lillchan , thx. Looks good to me, merging the PR.

@dikhan dikhan merged commit 5d335a8 into master Sep 18, 2020
@dikhan dikhan deleted the feature/resource-deterministic-order branch September 18, 2020 02:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation order is non-deterministic
2 participants