This is an automated email from the ASF dual-hosted git repository.
klesh pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-devlake.git
The following commit(s) were added to refs/heads/main by this push:
new c33efe815 feat(dev-container): add dev container (#8554)
c33efe815 is described below
commit c33efe815a80d3038ccb4501bd5c94d01490821d
Author: Kostas Petrakis <[email protected]>
AuthorDate: Mon Aug 25 06:01:22 2025 +0200
feat(dev-container): add dev container (#8554)
Many macOS developers use Homebrew to manage packages, and Homebrew
often installs its own version of libgit2 as a shared dependency for
other tools. This system-level installation frequently conflicts with
the version required by the plugin, forcing developers into complex
workarounds.
Dev container allow developers to overcome the issues regarding git2go
allowing them to properly test and run the code while contributing to
the project.
---
.devcontainer/Dockerfile | 24 +++++++++++++++
.devcontainer/devcontainer.json | 48 ++++++++++++++++++++++++++++++
.devcontainer/docker-compose.yml | 64 ++++++++++++++++++++++++++++++++++++++++
.devcontainer/post-install.sh | 19 ++++++++++++
4 files changed, 155 insertions(+)
diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile
new file mode 100644
index 000000000..9bf603913
--- /dev/null
+++ b/.devcontainer/Dockerfile
@@ -0,0 +1,24 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+FROM mcr.microsoft.com/devcontainers/go:1-1.22-bookworm
+
+ENV PKG_CONFIG_PATH=$PKG_CONFIG_PATH:/usr/local/lib:/usr/local/lib/pkgconfig
+ENV LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/lib
+ENV
DEVLAKE_PLUGINS=bamboo,bitbucket,circleci,customize,dora,gitextractor,github,github_graphql,gitlab,jenkins,jira,org,pagerduty,refdiff,slack,sonarqube,trello,webhook
+
+RUN apt-get update -y
+RUN apt-get install pkg-config python3-dev default-libmysqlclient-dev
build-essential libpq-dev cmake -y
+RUN git clone -b v1.3.0 https://github.com/libgit2/libgit2.git && cd libgit2
&& mkdir build && cd build && cmake .. && make && make install
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
new file mode 100644
index 000000000..d1e59507c
--- /dev/null
+++ b/.devcontainer/devcontainer.json
@@ -0,0 +1,48 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+{
+ "name": "Go",
+ "dockerComposeFile": "docker-compose.yml",
+ "service": "devcontainer",
+ "workspaceFolder": "/workspace",
+ "features": {
+ "ghcr.io/jungaretti/features/make:1": {},
+ "ghcr.io/devcontainers/features/docker-in-docker:2.12.0": {},
+ "ghcr.io/devcontainers/features/python:1": {
+ "version": "3.9"
+ },
+ "ghcr.io/devcontainers-extra/features/poetry:2": {},
+ "ghcr.io/devcontainers/features/node:1": {
+ "version": "18"
+ }
+ },
+ "forwardPorts": [
+ 4000,
+ 8080
+ ],
+ "postCreateCommand": "npm install commitizen -g",
+ "customizations": {
+ "vscode": {
+ "extensions": [
+ "streetsidesoftware.code-spell-checker"
+ ]
+ }
+ },
+ "remoteUser": "root"
+}
\ No newline at end of file
diff --git a/.devcontainer/docker-compose.yml b/.devcontainer/docker-compose.yml
new file mode 100644
index 000000000..b30d7a75b
--- /dev/null
+++ b/.devcontainer/docker-compose.yml
@@ -0,0 +1,64 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+version: '3.8'
+services:
+ devcontainer:
+ build:
+ dockerfile: Dockerfile
+ volumes:
+ - ..:/workspace
+ networks:
+ - default
+ command: sleep infinity
+ mysql:
+ image: mysql:8
+ volumes:
+ - mysql-storage:/var/lib/mysql
+ restart: always
+ ports:
+ - 3306:3306
+ environment:
+ MYSQL_ROOT_PASSWORD: admin
+ MYSQL_DATABASE: lake
+ MYSQL_USER: merico
+ MYSQL_PASSWORD: merico
+ TZ: UTC
+ command: --character-set-server=utf8mb4 --collation-server=utf8mb4_bin
--skip-log-bin
+ networks:
+ - default
+ grafana:
+ image: devlake.docker.scarf.sh/apache/devlake-dashboard:latest
+ ports:
+ - 3002:3000
+ volumes:
+ - grafana-storage:/var/lib/grafana
+ environment:
+ GF_SERVER_ROOT_URL: "http://localhost:4000/grafana";
+ GF_USERS_DEFAULT_THEME: "light"
+ MYSQL_URL: mysql:3306
+ MYSQL_DATABASE: lake
+ MYSQL_USER: merico
+ MYSQL_PASSWORD: merico
+ TZ: UTC
+ restart: always
+ depends_on:
+ - mysql
+ networks:
+ - default
+
+volumes:
+ mysql-storage:
+ grafana-storage:
\ No newline at end of file
diff --git a/.devcontainer/post-install.sh b/.devcontainer/post-install.sh
new file mode 100644
index 000000000..4ed2ecce3
--- /dev/null
+++ b/.devcontainer/post-install.sh
@@ -0,0 +1,19 @@
+#!/bin/sh
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+make dep
+npm install commitizen -g
\ No newline at end of file
