Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prepare for v1.0.0 release #29

Merged
merged 1 commit into from
Aug 22, 2023
Merged

Prepare for v1.0.0 release #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,3 +112,14 @@ docker compose -f modules/drivers/materialize/docker-compose.yml up -d metabase
```

It should pick up the driver jar as a volume.

## Cutting a release

Once the driver is ready to be released and tests are passing, you need to create a tag in the Metabase repository:

```bash
git tag -a vX.Y.Z -m vX.Y.Z
git push origin vX.Y.Z
```

Once the tag is pushed, the CI will build the driver and create a release including the jar file. You can manually edit the release description to include any additional release notes.
20 changes: 11 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The `metabase-materialize-driver` lets
[Metabase](https://github.com/metabase/metabase) connect to an instance of
[Materialize](https://github.com/MaterializeInc/materialize).

![Choose Materialize from database dropdown](images/materialize-metabase.png)
![Choose Materialize from database dropdown](https://github-production-user-asset-6210df.s3.amazonaws.com/21223421/262440951-6439ee5f-2aad-4742-ad54-e7548323f7b7.png)

## To Use the Driver

Expand All @@ -20,13 +20,15 @@ following sections.)
Once the Materialize driver is registered, use the following information to
connect:

| Field | Value |
| ----------------- |:---------:|
| Host | localhost |
| Port | 6875 |
| Database username | default |
| Database password | default |
| Cluster name | default |
| Field | Value |
| ----------------- |:----------------------:|
| Database type | **Materialize** |
| Host | Materialize host name. |
| Port | **6875** |
| Database name | **materialize** |
| Cluster name | **default** |
| Database username | Materialize user. |
| Database password | App-specific password. |

[releases]: https://github.com/MaterializeInc/metabase-materialize-driver/releases
[materialize/metabase]: https://hub.docker.com/repository/docker/materialize/metabase
Expand All @@ -36,7 +38,7 @@ connect:
Metabase Release | Driver Version
---------------- | --------------
v0.46.7 | v0.1.0
v0.47.0 | v0.1.1
v0.47.0 | v1.0.0

## Contributing

Expand Down
Binary file removed images/materialize-metabase.png
View file
Open in desktop
Binary file not shown.
2 changes: 1 addition & 1 deletion resources/metabase-plugin.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Reference: https://github.com/metabase/metabase/wiki/Metabase-Plugin-Manifest-Reference
info:
name: Metabase Materialize Driver
version: 0.1.0-SNAPSHOT
version: 1.0.0
description: Allows Metabase to connect to Materialize.
driver:
name: materialize
Expand Down