switch to commit-time plux entrypoint detection (#13643)

alexrashed · web-flow · commit 0073e19068f5 · 2026-01-30T08:12:24.000+01:00
diff --git a/.github/workflows/aws-tests.yml b/.github/workflows/aws-tests.yml
@@ -225,6 +225,9 @@ jobs:
       - name: Linting
         run: make lint
 
+      - name: Verify Plux Entrypoints
+        run: make entrypoints && git diff --exit-code plux.ini
+
       - name: Check AWS compatibility markers
         run: make check-aws-markers
 
diff --git a/.github/workflows/tests-pro-integration.yml b/.github/workflows/tests-pro-integration.yml
@@ -280,21 +280,6 @@ jobs:
           source .venv/bin/activate
           pip install -e ../localstack[runtime,test]
 
-      - name: Create Community Entrypoints
-        working-directory: localstack
-        # Entrypoints need to be generated _after_ the community edition has been linked into the venv
-        run: |
-          VENV_DIR="../localstack-pro/.venv" make entrypoints
-          ../localstack-pro/.venv/bin/python -m plux show
-
-      - name: Create Pro Entrypoints
-        working-directory: localstack-pro
-        # Entrypoints need to be generated _after_ the community edition has been linked into the venv
-        run: |
-          make entrypoints
-          cd localstack-pro-core
-          ../.venv/bin/python -m plux show
-
       - name: Test Pro Startup
         env:
           DEBUG: 1
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,5 +1,6 @@
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
+# TODO add pre-commit hook for plux entrypoints reconciliation on changed files
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
     # Ruff version.
@@ -22,6 +23,7 @@ repos:
     hooks:
       - id: no-commit-to-branch
       - id: end-of-file-fixer
+        exclude: "plux.ini"
       - id: trailing-whitespace
       - id: check-json
         files: .*\.(snapshot|validation)\.json
diff --git a/Dockerfile b/Dockerfile
@@ -129,7 +129,7 @@ COPY --from=builder /opt/code/localstack/.venv /opt/code/localstack/.venv
 ARG LOCALSTACK_BUILD_VERSION
 
 # add project files necessary to install all dependencies
-ADD Makefile pyproject.toml ./
+ADD Makefile pyproject.toml plux.ini ./
 # add the localstack start scripts (necessary for the installation of the runtime dependencies, i.e. `pip install -e .`)
 ADD bin/localstack bin/localstack.bat bin/localstack-supervisor bin/
 
@@ -142,10 +142,6 @@ RUN --mount=type=cache,target=/root/.cache \
     SETUPTOOLS_SCM_PRETEND_VERSION_FOR_LOCALSTACK_CORE=${LOCALSTACK_BUILD_VERSION} \
     pip install -e .[runtime]
 
-# Generate the plugin entrypoints
-RUN SETUPTOOLS_SCM_PRETEND_VERSION_FOR_LOCALSTACK_CORE=${LOCALSTACK_BUILD_VERSION} \
-    make entrypoints
-
 # Generate service catalog cache in static libs dir
 RUN . .venv/bin/activate && python3 -m localstack.aws.spec
 
diff --git a/Dockerfile.s3 b/Dockerfile.s3
@@ -76,7 +76,7 @@ COPY --from=builder /opt/code/localstack/.venv /opt/code/localstack/.venv
 ARG LOCALSTACK_BUILD_VERSION
 
 # add project files necessary to install all dependencies
-ADD Makefile pyproject.toml requirements-base-runtime.txt ./
+ADD Makefile pyproject.toml plux.ini requirements-base-runtime.txt ./
 # add the localstack start scripts (necessary for the installation of the runtime dependencies, i.e. `pip install -e .`)
 ADD bin/localstack bin/localstack.bat bin/localstack-supervisor bin/
 
@@ -89,10 +89,6 @@ RUN --mount=type=cache,target=/root/.cache \
     SETUPTOOLS_SCM_PRETEND_VERSION_FOR_LOCALSTACK_CORE=${LOCALSTACK_BUILD_VERSION} \
     pip install -e .[base-runtime]
 
-# Generate the plugin entrypoints
-RUN SETUPTOOLS_SCM_PRETEND_VERSION_FOR_LOCALSTACK_CORE=${LOCALSTACK_BUILD_VERSION} \
-    make entrypoints
-
 # Generate service catalog cache in static libs dir
 RUN . .venv/bin/activate && python3 -m localstack.aws.spec
 
diff --git a/Makefile b/Makefile
@@ -27,7 +27,7 @@ usage:                    ## Show this help
 
 $(VENV_ACTIVATE): pyproject.toml
 	test -d $(VENV_DIR) || $(VENV_BIN) $(VENV_DIR)
-	$(VENV_RUN); $(PIP_CMD) install --upgrade pip setuptools wheel plux
+	$(VENV_RUN); $(PIP_CMD) install --upgrade pip setuptools wheel
 	touch $(VENV_ACTIVATE)
 
 venv: $(VENV_ACTIVATE)    ## Create a new (empty) virtual environment
@@ -69,14 +69,14 @@ install-s3: venv     ## Install dependencies for the localstack runtime for s3-o
 	$(VENV_RUN); $(PIP_CMD) install -r requirements-base-runtime.txt
 	$(VENV_RUN); $(PIP_CMD) install $(PIP_OPTS) -e ".[base-runtime]"
 
-install: install-dev entrypoints  ## Install full dependencies into venv
+install: install-dev      ## Install full dependencies into venv
 
-entrypoints:              ## Run plux to build entry points
-	$(VENV_RUN); python3 -c "from setuptools import setup; setup()" plugins egg_info
-	@# make sure that the entrypoints were correctly created and are non-empty
-	@test -s localstack-core/localstack_core.egg-info/entry_points.txt || (echo "Entrypoints were not correctly created! Aborting!" && exit 1)
+entrypoints: install-dev
+	$(VENV_RUN); python -m plux entrypoints
+	@# make sure that the plux.ini file with the entrypoints has correctly been created
+	@test -s plux.ini || (echo "Entrypoints were not correctly created! Aborting!" && exit 1)
 
-dist: entrypoints        ## Build source and built (wheel) distributions of the current version
+dist:                     ## Build source and built (wheel) distributions of the current version
 	$(VENV_RUN); pip install --upgrade build twine; python -m build
 
 publish: clean-dist dist  ## Publish the library to the central PyPi repository
diff --git a/docs/localstack-concepts/README.md b/docs/localstack-concepts/README.md
@@ -143,9 +143,9 @@ Plugins provided by [https://github.com/localstack/plux](https://github.com/loca
 -   Hooks
 -   Extensions
 
-Key points to understand are that plugins use [Python entry points, which are part of the PyPA specification](https://packaging.python.org/en/latest/specifications/entry-points/). Entry points are discovered from the code during a build step rather than defined manually (this is the main differentiator of Plux to other code loading tools). In LocalStack, the `make entrypoints` make target does that, which is also part of `make install`.
+Key points to understand are that plugins use [Python entry points, which are part of the PyPA specification](https://packaging.python.org/en/latest/specifications/entry-points/). Entry points are discovered from the code and maintained in the `plux.ini` file, which is version-controlled. This file is used at build time to generate the entry points for the Python package.
 
-When you add new hooks or service providers, or any other plugin, make sure to run `make entrypoints`.
+When you add new hooks or service providers, or any other plugin, make sure to run `make entrypoints` to update the `plux.ini` file, and commit the changes to version control.
 
 When writing plugins, it is important to understand that any code that sits in the same module as the plugin, will be imported when the plugin is _resolved_. That is, _before_ it is loaded. Resolving a plugin simply means discovering the entry points and loading the code the underlying entry point points to. This is why many times you will see imports deferred to the actual loading of the plugin.
 
diff --git a/localstack-core/localstack/services/cloudformation/scaffolding/__main__.py b/localstack-core/localstack/services/cloudformation/scaffolding/__main__.py
@@ -922,7 +922,7 @@ def generate(
         )
     console.print("\nWondering where to get started?")
     console.print(
-        "First run `make entrypoints` to make sure your resource provider plugin is actually registered."
+        "First run `make entrypoints` to update the plux.ini file with your new resource provider plugin."
     )
     console.print(
         'Then start off by finalizing the generated minimal ("basic") template and get it to deploy against AWS.'
diff --git a/plux.ini b/plux.ini
diff --git a/pyproject.toml b/pyproject.toml

Original file line number	Diff line number	Diff line change
`@@ -922,7 +922,7 @@ def generate(`
`922`	`922`	`)`
`923`	`923`	`console.print("\nWondering where to get started?")`
`924`	`924`	`console.print(`
`925`		- "First run `make entrypoints` to make sure your resource provider plugin is actually registered."
	`925`	+ "First run `make entrypoints` to update the plux.ini file with your new resource provider plugin."
`926`	`926`	`)`
`927`	`927`	`console.print(`
`928`	`928`	`'Then start off by finalizing the generated minimal ("basic") template and get it to deploy against AWS.'`