airbyte-connector/Makefile at main · surrealdb/airbyte-connector · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
# This Makefile automates the setup, build, and testing process for the
# Airbyte SurrealDB destination connector. It manages cloning the main
# Airbyte repository and symlinking the local connector code into the
# correct directory structure, allowing the use of 'airbyte-ci' tools.

# Variables
AIRBYTE_REPO_URL := https://github.com/airbytehq/airbyte.git
AIRBYTE_DIR := airbyte
CONNECTOR_NAME := destination-surrealdb
CONNECTOR_DIR := $(CONNECTOR_NAME)
DOCS_DIR := docs/integrations/destinations
AIRBYTE_CONNECTORS_DIR := $(AIRBYTE_DIR)/airbyte-integrations/connectors
AIRBYTE_DOCS_DIR := $(AIRBYTE_DIR)/docs/integrations/destinations

.PHONY: all setup-dev build test clean develop

all: build test

# Setup development environment: Clones Airbyte repo and symlinks the connector
setup-dev: $(AIRBYTE_DIR)
	@echo "Development environment setup."

$(AIRBYTE_DIR):
	@echo "Cloning Airbyte repository into $(AIRBYTE_DIR)..."
	git clone --depth 1 $(AIRBYTE_REPO_URL) $(AIRBYTE_DIR)
	@echo "Copying $(CONNECTOR_NAME) to the Airbyte repository..."
	rm -rf $(AIRBYTE_CONNECTORS_DIR)/$(CONNECTOR_NAME)
	cp -r $(CONNECTOR_DIR) $(AIRBYTE_CONNECTORS_DIR)/$(CONNECTOR_NAME)
	@echo "Copied $(CONNECTOR_NAME) to the Airbyte repository"
	@echo "Copying docs to the Airbyte repository..."
	cp $(DOCS_DIR)/surrealdb.md $(AIRBYTE_DOCS_DIR)/surrealdb.md
	cp $(DOCS_DIR)/surrealdb-migrations.md $(AIRBYTE_DOCS_DIR)/surrealdb-migrations.md
	@echo "Copied docs to the Airbyte repository"

# Build the connector using airbyte-ci
build: setup-dev
	@echo "Building $(CONNECTOR_NAME) connector..."
	cd $(AIRBYTE_DIR) && airbyte-ci connectors --name $(CONNECTOR_NAME) build

# Run tests for the connector using airbyte-ci
test: setup-dev
	@echo "Testing $(CONNECTOR_NAME) connector..."
	cd $(AIRBYTE_DIR) && airbyte-ci connectors --name=$(CONNECTOR_NAME) test -x qa_checks

# Clean up the development environment
clean:
	@echo "Cleaning up..."
	rm -rf $(AIRBYTE_DIR)
	@echo "Removed $(AIRBYTE_DIR)."

# Setup development environment using Nix (as described in README)
.PHONY: develop
develop:
	@echo "Running nix develop to enter the development environment..."
	@echo "Follow instructions within the Nix shell if needed (e.g., activate venv, install deps)."
	nix develop

# This is the old way to install Airbyte dependencies within the Nix shell.
# It is not used anymore, but kept here for reference.
# Use the devcontainer instead. The devcontainer runs `make airbyte-dev` below on startup.
.PHONY: deps
deps:
	@echo "Installing Airbyte dependencies..."
	cd $(AIRBYTE_DIR) && \
	  python -m venv .venv && \
	  . .venv/bin/activate && \
	  pip install poetry && \
	  pip install pipx && \
	  make tools.airbyte-ci-dev.install

.PHONY: airbyte-dev
airbyte-dev: $(AIRBYTE_DIR)
	@echo "Installing Airbyte dependencies..."
	cd $(AIRBYTE_DIR) && \
	  pip install --user poetry && \
	  poetry config virtualenvs.in-project true && \
	  pip install pipx --user poetry && \
	  pipx install uv && \
	  make tools.airbyte-ci-dev.install
	@echo 'Airbyte devenv is ready. Run `cd $(AIRBYTE_DIR)` to get started!'
	@cat get-started.txt