CloudQuery draft version not deleting after removing configuration file

CloudQuery Plugins
1

Something I wanted to note while I was publishing a plugin version on Hub:

  1. I ran cloudquery plugin publish and uploaded a draft version with a docs/_configuration.md file. I had a thought that I would just include _configuration.md into overview.md, so I deleted the _configuration.md file and re-published to CloudQuery. CloudQuery kept the _configuration docs page when viewing it via the cloud.cloudquery.io interface. I expected CloudQuery to remove it.

  2. As a result of the above, I wanted to delete the version and re-publish fresh, but there is no mechanism to delete a draft version. Would be nice to have.

2

Hi Dotty! Thanks, can you please open an issue here - https://github.com/cloudquery/cloudquery/issues? In the meanwhile, can you just publish a new version and keep the previous one as draft?

3

Sure, no problem. And yeah, no blockers here. Just wanted to make note of the experience. Thanks!

4

@fancy-basilisk In a pinch, you can use the cloudquery plugin docs upload (long I know!) command with the sync option to update the docs and remove old ones. It would be something like:

cloudquery plugin docs upload -D path-to-your-docs-dir/ --sync your_team/your_plugin_kind/your_plugin_name@version

your_plugin_kind is either source or destination.
version starts with a “v”, something like v1.0.0.

The sync option will compare the list of docs with the ones you have in the directory and delete docs that are missing from your local directory, while updating the rest.

5

In the meantime, we’ve also released a new CLI today (v4.3.3) that “syncs” the docs fully on a draft plugin (the issue you experienced), so from now on that still works and old docs would be deleted.

Also, a good note is the cloudquery plugin docs command works even if the plugin has been published, so it’s a good way to fix/update current docs (of a specific already released version) without publishing new versions.