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

Sync examples with examples-generated #20

Open
ytsarev opened this issue Jul 21, 2022 · 2 comments
Open

Sync examples with examples-generated #20

ytsarev opened this issue Jul 21, 2022 · 2 comments
Labels
enhancement New feature or request

Comments

@ytsarev
Copy link
Member

ytsarev commented Jul 21, 2022

What problem are you facing?

We inherited a set of examples from community jet providers without explicitly retesting them.

It resulted inpoor user experience in the case when old example heavily deviated from the current provider state especially after substantial underlying terraform provider bump which was a part of official-providers repo initialization.

Provider Name: all of them

How could Official Providers help solve your problem?

To attack this problem we can sync up examples directory(the one that is exposed in the Marketplace) with the examples from examples-generated which contain more up-to-date examples closely following the actual resource configuration.

We also can make an attempt of mass example retesting for the examples that are changed after the sync.

@ytsarev ytsarev added the enhancement New feature or request label Jul 21, 2022
@muvaf
Copy link
Contributor

muvaf commented Jul 21, 2022

The ideal flow we'd like to achieve with example generation is that there is a single folder that's regenerated at each run and the manual overrides would be defined in the code. So, the work we're targeting here could be to make examples in examples-generated folder exactly the same with what we have in examples folder via overrides and then remove the examples folder altogether. Then we'd rename examples-generated to be examples and use that everywhere.

@ytsarev I think this should be separate from actual testing of the examples which is described in https://github.com/upbound/official-providers/issues/410

@ytsarev
Copy link
Member Author

ytsarev commented Jul 21, 2022

@muvaf not sure about the separation. I imagine the following flow that will happen in upbound/official-providers#410

  • we test the current example from examples
  • assuming it fails we copy the one from examples-generated
  • in most of the cases it should fix the examples unless we hit origin tf registry documentation issue

The question if we want to test existing old examples as they are or sync them up with examples-generated right away

@jeanduplessis jeanduplessis transferred this issue from another repository Oct 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants