feat(workflow): push `apisix:dev` image on commit by SkyeYoung · Pull Request #12300 · apache/apisix

SkyeYoung · 2025-06-09T08:15:51Z

Description

What

This is a part of #12234.

This PR add a workflow, so that when submitting a commit in any PR, the build and push(only master) of the apisix:dev image will be triggered.

How

This PR moves the https://github.com/apache/apisix-docker/blob/d5322d57d58c569d98c225f89a8abd991429ec10/.github/workflows/apisix_dev_push_docker_hub.yaml and related files into apisix.

Why

During the development and CI process of apisix-dashboard, the latest dev image with the latest code is required.
The dev images built in apisix-docker in the past were more like nightly images, only released at a specific time each day, which hindered developers from using images with the latest code for testing.
Since apisix-dashboard has already been integrated into apisix, the apisix-docker repository no longer has much significance and also lacks maintenance. Integrating it directly into the apisix repository will be easier to maintain.

Depend on

We need to request the ASF Infra team to add Docker Hub credentials for the APISIX repository. This repository is now not authorized to push images.

Which issue(s) this PR fixes:

Fixes #

Checklist

I have explained the need for this PR and the problem it solves
I have explained the changes or the new features added to this PR
I have added tests corresponding to this change
I have updated the documentation to reflect this change
I have verified that this change is backward compatible (If not, please discuss on the APISIX mailing list first)

SkyeYoung · 2025-06-09T08:56:39Z

+on:
+  push:
+    branches:
+      - master
+    paths-ignore:
+      - "docs/**"
+      - "**/*.md"
+  workflow_dispatch:


Here is the only difference from https://github.com/apache/apisix-docker/blob/master/.github/workflows/apisix_dev_push_docker_hub.yaml .

Removed the schedule because we are already able to ensure the latest.

Added workflow_dispatch to allow manual triggering of builds if necessary.

It is best to build each time a contributor commits (in the their dev branch), but not push, to help us detect potential build errors in advance.

It is best to build each time a contributor commits (in the their dev branch), but not push, to help us detect potential build errors in advance.

done.

SkyeYoung · 2025-06-09T08:58:56Z

+    restart: always
+    environment:


Here is the only difference from https://github.com/apache/apisix-docker/blob/d5322d57d58c569d98c225f89a8abd991429ec10/compose/docker-compose-master.yaml#L40.

I removed the unnecessary volume map

SkyeYoung · 2025-06-09T09:17:15Z

+    wget -q https://github.com/google/brotli/archive/refs/tags/v${BORTLI_VERSION}.zip || exit 1
+    unzip v${BORTLI_VERSION}.zip && cd ./brotli-${BORTLI_VERSION} && mkdir build && cd build || exit 1
+    local CMAKE=$(command -v cmake3 >/dev/null 2>&1 && echo cmake3 || echo cmake) || exit 1
+    ${CMAKE} -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr/local/brotli .. || exit 1
+    sudo ${CMAKE} --build . --config Release --target install || exit 1
+    if [ -d "/usr/local/brotli/lib64" ]; then
+        echo /usr/local/brotli/lib64 | sudo tee /etc/ld.so.conf.d/brotli.conf
+    else
+        echo /usr/local/brotli/lib | sudo tee /etc/ld.so.conf.d/brotli.conf
+    fi
+    sudo ldconfig || exit 1


Here, change all "exit -1" to "exit 1".

I don't know how the original file in apisix-docker passed the review before, which doesn't fit the shell specifications I know, nor can I pass the ci in apisix

https://github.com/apache/apisix/actions/runs/15530989377/job/43719749891?pr=12300

This change won't break any existing logic, because I don't see any place that receives -1 either.

SkyeYoung · 2025-06-09T09:45:30Z

The current script itself has problems and cannot be built in the apisix-docker repository.

https://github.com/apache/apisix-docker/actions/runs/15524834524

I tried it locally and couldn't build the image

Waiting for a fix in apisix.

juzhiyuan

Need @bzp2010 @nic-6443's help to have a review 🙏

…ow/push-dev-image-on-commit

SkyeYoung · 2025-06-10T09:42:13Z

The current script itself has problems and cannot be built in the apisix-docker repository.

apache/apisix-docker/actions/runs/15524834524

I tried it locally and couldn't build the image

Waiting for a fix in apisix.

Merged the latest master of APISIX, all working fine.

nic-6443 · 2025-06-11T07:08:34Z

+# limitations under the License.
+#
+
+FROM api7/apisix-runtime:dev AS build


I found api7/apisix-runtime:dev is outdated, we can replace this dockerfile with https://github.com/apache/apisix-docker/blob/master/debian-dev/Dockerfile.local

nic-6443 · 2025-06-11T08:29:32Z

+    runs-on: ubuntu-latest
+
+    env:
+      APISIX_VERSION: master


this env is unused?

…ow/push-dev-image-on-commit

Copilot

Pull Request Overview

This PR integrates the dev-image build pipeline into the main repository by moving Docker scripts and workflows from apisix-docker into apisix, and adds a GitHub Actions workflow to build and push the apache/apisix:dev image on every commit.

Introduce check_standalone_config.sh to validate standalone-mode settings
Add install-brotli.sh, docker-entrypoint.sh, Debian-dev Dockerfile and compose files
Add Makefile targets (build-on-debian-dev, push-multiarch-dev-on-debian) and a GitHub Actions workflow

Reviewed Changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
docker/utils/check_standalone_config.sh	New script to enforce standalone-mode config in `config.yaml`
docker/debian-dev/install-brotli.sh	Script to download, build, install, and clean up Brotli
docker/debian-dev/docker-entrypoint.sh	Entrypoint handling standalone vs cluster initialization
docker/debian-dev/Dockerfile	Multi-stage build for Debian-based dev image
docker/compose/docker-compose-master.yaml	Compose definition for local dev environment
docker/compose/apisix_conf/master/config.yaml	Master config for compose-based dev environment
Makefile	Targets to build/push Debian-dev and multiarch dev images
.github/workflows/push-dev-image-on-commit.yml	CI workflow to build, test, and push `apisix:dev` on commit

Comments suppressed due to low confidence (2)

docker/debian-dev/install-brotli.sh:22

[nitpick] The variable name BORTLI_VERSION is a typo and can be confusing; consider renaming it to BROTL I_VERSION to match the project name and improve readability.

    local BORTLI_VERSION="1.1.0"

docker/utils/check_standalone_config.sh:1

[nitpick] This new validation script is untested; consider adding unit or integration tests to verify each error path in check_standalone_config.sh.

#!/usr/bin/env bash

membphis

LGTM

One minor issue, we can fix it later

membphis · 2025-06-12T02:17:45Z

+      - apisix
+
+  etcd:
+    image: bitnami/etcd:3.4.9


the lastest bitnami/etcd is 3.6.*
I think we should update it

Let's create a issue.

feat(workflow): add push dev image on commit

300cb17

SkyeYoung commented Jun 9, 2025

View reviewed changes

SkyeYoung added 2 commits June 9, 2025 09:08

fix: lint

1cfb7dd

fix: error shell exit code

cdd5a3c

SkyeYoung commented Jun 9, 2025

View reviewed changes

SkyeYoung requested review from bzp2010, Copilot and juzhiyuan June 9, 2025 09:20

This comment was marked as outdated.

Sign in to view

SkyeYoung added 2 commits June 9, 2025 09:24

fix: Makefile

1c1449d

chore: rollback

9606b29

SkyeYoung marked this pull request as ready for review June 9, 2025 09:29

dosubot Bot added size:L This PR changes 100-499 lines, ignoring generated files. enhancement New feature or request github_actions Pull requests that update GitHub Actions code labels Jun 9, 2025

SkyeYoung changed the title ~~feat(workflow): add push dev image on commit~~ feat(workflow): add push apisix:dev image on commit Jun 9, 2025

SkyeYoung changed the title ~~feat(workflow): add push apisix:dev image on commit~~ feat(workflow): push apisix:dev image on commit Jun 9, 2025

juzhiyuan reviewed Jun 9, 2025

View reviewed changes

Merge remote-tracking branch 'upstream/master' into young/feat/workfl…

2e1e97a

…ow/push-dev-image-on-commit

feat: build on every commit, but only push on the master branch

e5d9ed7

SkyeYoung requested a review from nic-6443 June 10, 2025 09:57

This comment was marked as resolved.

Sign in to view

nic-6443 previously approved these changes Jun 11, 2025

View reviewed changes

nic-6443 reviewed Jun 11, 2025

View reviewed changes

nic-6443 self-requested a review June 11, 2025 07:10

feat: replace with Dockerfile.local

cc98f74

SkyeYoung dismissed nic-6443’s stale review via cc98f74 June 11, 2025 07:38

SkyeYoung added 3 commits June 11, 2025 07:40

fix: lint

ea43329

chore: rollback error format

631f412

chore: replace ENV LegacyKeyValueFormat, wrong placeholder

1637524

nic-6443 reviewed Jun 11, 2025

View reviewed changes

SkyeYoung added 5 commits June 11, 2025 08:35

Merge remote-tracking branch 'upstream/master' into young/feat/workfl…

7410a51

…ow/push-dev-image-on-commit

fix: build-on-debian-dev cmd

fd4b644

chore: rm useless code and env

f0009b5

feat: add pull_request

d240408

fix: permission

7816f2b

SkyeYoung requested review from AlinsRan and nic-6443 June 11, 2025 11:07

nic-6443 approved these changes Jun 12, 2025

View reviewed changes

AlinsRan approved these changes Jun 12, 2025

View reviewed changes

SkyeYoung requested review from Copilot, juzhiyuan and membphis June 12, 2025 01:10

Copilot AI reviewed Jun 12, 2025

View reviewed changes

Comment thread Makefile

Comment thread docker/debian-dev/install-brotli.sh

Comment thread .github/workflows/push-dev-image-on-commit.yml

membphis approved these changes Jun 12, 2025

View reviewed changes

SkyeYoung merged commit 3137d57 into apache:master Jun 12, 2025
42 of 44 checks passed

SkyeYoung deleted the young/feat/workflow/push-dev-image-on-commit branch June 12, 2025 02:24

This was referenced Jun 13, 2025

chore(docker): update etcd config #12328

Merged

fix(docker): install libyaml in arm64 #12329

Merged

laz-xyr pushed a commit to laz-xyr/apisix that referenced this pull request Jun 19, 2025

feat(workflow): push apisix:dev image on commit (apache#12300)

9d1e958

Uh oh!

Conversation

SkyeYoung commented Jun 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Which issue(s) this PR fixes:

Checklist

Uh oh!

SkyeYoung Jun 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This comment was marked as outdated.

Uh oh!

SkyeYoung commented Jun 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

juzhiyuan left a comment

Choose a reason for hiding this comment

Uh oh!

SkyeYoung commented Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment was marked as resolved.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

membphis left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

SkyeYoung commented Jun 9, 2025 •

edited

Loading

SkyeYoung Jun 9, 2025 •

edited

Loading

SkyeYoung commented Jun 9, 2025 •

edited

Loading

SkyeYoung commented Jun 10, 2025 •

edited

Loading