chore: Add migration guides for v1 plugins#2034
Merged
hermanschaaf merged 5 commits intomainfrom Sep 26, 2022
Merged
Conversation
erezrokah
approved these changes
Sep 25, 2022
Member
erezrokah
left a comment
There was a problem hiding this comment.
Nice @hermanschaaf 🚀 Per an internal decision on versioning, we should call the new version v1 as we've never had a major v1 version
Contributor
Author
|
Thanks @erezrokah - renamed v1 -> v0, and v2 -> v1 😄 |
yevgenypats
pushed a commit
that referenced
this pull request
Sep 26, 2022
Adds migration guides for v1 plugins. Guides added in this PR: - [AWS](https://github.com/cloudquery/cloudquery/blob/migration-guides/plugins/source/aws/docs/v1-migration.md) (Updated) - [Azure](https://github.com/cloudquery/cloudquery/blob/migration-guides/plugins/source/azure/docs/v1-migration.md) - [Cloudflare](https://github.com/cloudquery/cloudquery/blob/migration-guides/plugins/source/cloudflare/docs/v1-migration.md) - [DigitalOcean](https://github.com/cloudquery/cloudquery/blob/migration-guides/plugins/source/digitalocean/docs/v1-migration.md) - [GCP](https://github.com/cloudquery/cloudquery/blob/migration-guides/plugins/source/gcp/docs/v1-migration.md) - [Github](https://github.com/cloudquery/cloudquery/blob/migration-guides/plugins/source/github/docs/v1-migration.md) - [Okta](https://github.com/cloudquery/cloudquery/blob/migration-guides/plugins/source/okta/docs/v1-migration.md) Heroku was left out because it was never released pre-v1. K8s will be added when it is ready, and terraform requires some changes to work (will follow up later today). Generating these requires a bit of manual setup, but for future reference, the process I have locally right now can be replicated using something like this: ``` git worktree add ../v0 git worktree add ../v1 cd ../v0 && git checkout ab65d1e # or any v0 commit cd ../v1 && make build cd .. ``` Then run this script from outside the git root: ``` plugins="aws gcp azure cloudflare digitalocean github okta" mkdir -p docs/tables-v0 mkdir -p docs/tables-v1 for p in $plugins do echo "Generating migration guide for $p" cp -r v0/plugins/source/$p/docs/tables/* docs/tables-v0 ./v1/bin/$p doc docs/tables-v1 ./v1/bin/v1-migration -o cloudquery/plugins/source/$p/docs/v1-migration.md -v1 docs/tables-v0 -v2 docs/tables-v1 done ```
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds migration guides for v1 plugins. Guides added in this PR:
Heroku was left out because it was never released pre-v1. K8s will be added when it is ready, and terraform requires some changes to work (will follow up later today).
Generating these requires a bit of manual setup, but for future reference, the process I have locally right now can be replicated using something like this:
Then run this script from outside the git root: