Skip to content
This repository has been archived by the owner on Dec 3, 2024. It is now read-only.

Commit

Permalink
chore(docs): Add development and release guide (#8)
Browse files Browse the repository at this point in the history
  • Loading branch information
erezrokah authored Feb 16, 2023
1 parent 40a15ae commit 4c2b9fa
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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: <version> 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

0 comments on commit 4c2b9fa

Please sign in to comment.