Categorygithub.com/joekarlsson/cq-source-xkcd
repositorypackage
0.1.0
Repository: https://github.com/joekarlsson/cq-source-xkcd.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author

# README

CloudQuery xkcd Source Plugin

test Go Report Card

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

Links

Configuration

The following source configuration file will sync to a PostgreSQL database. See the CloudQuery Quickstart for more information on how to configure the source and destination.

kind: source
spec:
  name: "xkcd"
  path: "JoeKarlsson/xkcd"
  version: "${VERSION}"
  destinations:
    - "postgresql"
  spec:
    # plugin spec section

Development

Run tests

make test

Run linter

make lint

Generate docs

make gen-docs

Develop a Web UI for the plugin

See cloud-config-ui/README.md for more information.

Obtain API key

Please refer to the documentation for instructions.

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 CloudQuery Hub.