Skip to content

chore: Add migration guides for v1 plugins#2034

Merged
hermanschaaf merged 5 commits intomainfrom
migration-guides
Sep 26, 2022
Merged

chore: Add migration guides for v1 plugins#2034
hermanschaaf merged 5 commits intomainfrom
migration-guides

Conversation

@hermanschaaf
Copy link
Copy Markdown
Contributor

@hermanschaaf hermanschaaf commented Sep 23, 2022

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:

git worktree add ../v0
git worktree add ../v1
cd ../v0 && git checkout ab65d1e33 # 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

@hermanschaaf hermanschaaf requested a review from a team September 23, 2022 14:21
@hermanschaaf hermanschaaf changed the title Add migration guides for v2 plugins chore: Add migration guides for v2 plugins Sep 23, 2022
Copy link
Copy Markdown
Member

@erezrokah erezrokah left a comment

Choose a reason for hiding this comment

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

Nice @hermanschaaf 🚀 Per an internal decision on versioning, we should call the new version v1 as we've never had a major v1 version

@hermanschaaf hermanschaaf changed the title chore: Add migration guides for v2 plugins chore: Add migration guides for v1 plugins Sep 26, 2022
@hermanschaaf
Copy link
Copy Markdown
Contributor Author

hermanschaaf commented Sep 26, 2022

Thanks @erezrokah - renamed v1 -> v0, and v2 -> v1 😄

@hermanschaaf hermanschaaf merged commit 4ed3b04 into main Sep 26, 2022
@hermanschaaf hermanschaaf deleted the migration-guides branch September 26, 2022 09:50
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
```
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