Skip to content

Swetrix/cq-source-swetrix

Repository files navigation

CloudQuery Swetrix Source Plugin

A Swetrix source plugin for CloudQuery that loads data from Swetrix to any database, data warehouse or data lake supported by CloudQuery, such as PostgreSQL, BigQuery, Athena, and many more.

Links

Authentication

The Swetrix source plugin uses the Swetrix API to fetch data. You will need to create an API key in the Swetrix portal. See the Configuration section for more information on running the Swetrix plugin.

Development

Run tests

make test

Run linter

make lint

Generate docs

make gen-docs

Compile

make build

Release a new version

  1. Run git tag v1.0.0 to create a new tag for the release (replace v1.0.0 with the new version number)
  2. Run git push origin v1.0.0 to push the tag to GitHub

Once the tag is pushed, a new GitHub Actions workflow will be triggered to build the release binaries and create the new release on GitHub. To customize the release notes, see the Go releaser changelog configuration docs.

Publish a new version to the Cloudquery Hub

After tagging a release, you can build and publish a new version to the Cloudquery Hub by running the following commands. Replace v1.0.0 with the new version number.

# "make dist" uses the README as main documentation and adds a generic release note. Output is created in dist/
VERSION=v1.0.0 make dist

# Login to cloudquery hub and publish the new version
cloudquery login
cloudquery plugin publish --finalize

After publishing the new version, it will show up in the hub.

For more information please refer to the official Publishing a Plugin to the Hub guide.