diff --git a/README.md b/README.md index 9bc6a15..ed2bc02 100644 --- a/README.md +++ b/README.md @@ -77,3 +77,34 @@ Example result: INTRST PYMNT | {Transfer,Credit} | -4.22 | "USD" | 2023-01-25 | null | other (10 rows) ``` + +## Development + +### Run tests + +```bash +make test +``` + +### Run linter + +```bash +make lint +``` + +### Generate docs + +```bash +make gen-docs +``` + +### Release a new version + +1. Follow [this link](https://github.com/cloudquery/cq-source-plaid/releases/new) to draft a new release. +2. Click `Choose a tag` and enter the new version number: + ![image](https://user-images.githubusercontent.com/26760571/219360662-0ad1f83d-84c9-47c8-afb9-fe774ce03dcc.png) +3. Click `Create new tag: on publish` assuming it's a new tag. +4. Click `Generate release notes` to automatically generate release notes. +5. Click `Publish release` to publish the release. + +> Once the tag is pushed, a new GitHub Actions workflow will be triggered to build and upload the release binaries to the release