Skip to content

Commit

Permalink
docs: update contributing information, add Helm badge
Browse files Browse the repository at this point in the history
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
  • Loading branch information
virtualtam committed Jun 8, 2023
1 parent 7c4af8b commit e5b9911
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 37 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](https://semver.org/).

## [v2.0.0](https://github.com/botify-labs/airbyte_exporter/releases/tag/v2.0.0) - 2023-06-08

### Changed

- Breaking: transfer repository to `botify-labs` and update Go module imports
- Update documentation

## [v1.1.0](https://github.com/botify-labs/airbyte_exporter/releases/tag/v1.1.0) - 2023-05-17

### Fixed
Expand Down
34 changes: 34 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Contributing
## Building

Get the sources:

```shell
$ git clone https://github.com/botify-labs/airbyte_exporter.git
$ cd airbyte_exporter
```

Run linters:

```shell
$ make lint
```

Build the parser and exporter:

```shell
$ make build
```

Build platform-specific binaries with [Promu](https://github.com/prometheus/promu):

```shell
$ promu crossbuild
```

Build and archive platform-specific binaries:

```shell
$ promu crossbuild
$ promu crossbuild tarballs
```
45 changes: 8 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
<img src="https://github.com/botify-labs/airbyte_exporter/actions/workflows/ci.yaml/badge.svg?branch=main" alt="Continuous integration workflow status">
<img src="https://github.com/botify-labs/airbyte_exporter/actions/workflows/docker.yaml/badge.svg?branch=main" alt="Docker image workflow status">

[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/botify-helm-charts)](https://artifacthub.io/packages/search?repo=botify-helm-charts)

## Metrics exposed
### Counters
- `airbyte_connections_total{destination_connector, source_connector, status}`
Expand Down Expand Up @@ -103,11 +105,11 @@ ALTER DEFAULT PRIVILEGES IN SCHEMA public GRANT SELECT ON TABLES TO airbyte_expo
```

## Running

### Running with Docker
See [`airbyte_exporter` container packages](https://github.com/botify-labs/airbyte_exporter/pkgs/container/airbyte_exporter)
for a list of available Docker image tags.

### Docker

Pull the Docker image:

```shell
Expand All @@ -126,46 +128,15 @@ $ docker run \
ghcr.io/botify-labs/airbyte_exporter:latest
```

### Helm Chart for Kubernetes
### Deploying to Kubernetes with Helm

See instructions on Artifact Hub for [botify-helm-charts/prometheus-airbyte-exporter](https://artifacthub.io/packages/helm/botify-helm-charts/prometheus-airbyte-exporter).

## Building

Get the sources:

```shell
$ git clone https://github.com/botify-labs/airbyte_exporter.git
$ cd airbyte_exporter
```

Run linters:

```shell
$ make lint
```

Build the parser and exporter:

```shell
$ make build
```

Build platform-specific binaries with [Promu](https://github.com/prometheus/promu):

```shell
$ promu crossbuild
```

Build and archive platform-specific binaries:

```shell
$ promu crossbuild
$ promu crossbuild tarballs
```

## Change Log
See [CHANGELOG](./CHANGELOG.md)

## Contributing
See [CONTRIBUTING](./CONTRIBUTING.md)

## License
`airbyte_exporter` is licensed under the MIT License.

0 comments on commit e5b9911

Please sign in to comment.