Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
193 changes: 193 additions & 0 deletions .github/workflows/langflow-publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,193 @@
name: Langflow extension package

on:
pull_request:
paths:
- integrations/langflow/**
- scripts/gates/langflow_extension_smoke.py
- tests/unit/test_langflow_publication.py
- .github/workflows/langflow-publish.yml
push:
tags:
- lfx-loom-v*

permissions:
contents: read

jobs:
build:
runs-on: ubuntu-latest
timeout-minutes: 10
steps:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
fetch-depth: 0
- uses: actions/setup-python@6d4fd22b20465ccc0f7354476588e8df7c9ca0e0 # v7.1.0
with:
python-version: "3.11"
- uses: astral-sh/setup-uv@68559e99cc807c1eb7e9238fd43a15bba460eec2 # v10.3.3
with:
version: "0.12.19"
- name: Validate package identity and publication tag
id: publication-tag
env:
RELEASE_TAG: ${{ github.ref_name }}
IS_TAG: ${{ github.ref_type == 'tag' }}
run: |
python - <<'PY'
import json
import os
from pathlib import Path
import re
import tomllib

source = Path("integrations/langflow")
project = tomllib.loads((source / "pyproject.toml").read_text())["project"]
manifest = json.loads((source / "extension.json").read_text())
assert project["name"] == manifest["id"] == "lfx-loom"
version = project["version"]
assert re.fullmatch(r"(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)", version)
assert manifest["version"] == version
if os.environ["IS_TAG"] == "true":
assert os.environ["RELEASE_TAG"] == f"lfx-loom-v{version}"
PY
- name: Require the publication commit to be on main
id: publication-source
if: github.ref_type == 'tag'
run: git merge-base --is-ancestor HEAD origin/main
- name: Build the wheel and source distribution
run: |
uv build integrations/langflow --out-dir "$RUNNER_TEMP/lfx-dist"
mkdir "$RUNNER_TEMP/lfx-sdist"
tar -xzf "$RUNNER_TEMP"/lfx-dist/*.tar.gz -C "$RUNNER_TEMP/lfx-sdist"
uv build --wheel "$RUNNER_TEMP"/lfx-sdist/* --out-dir "$RUNNER_TEMP/lfx-rebuilt"
- name: Check both wheels and the source archive
run: |
python - <<'PY'
from email.parser import BytesParser
from pathlib import Path
import os
import tomllib
import zipfile

from scripts.gates.langflow_extension_smoke import check_sdist, check_wheel, only

source = Path("integrations/langflow")
project = tomllib.loads((source / "pyproject.toml").read_text())["project"]
expected = {
"lfx_loom/__init__.py": (source / "src/lfx_loom/__init__.py").read_bytes(),
"lfx_loom/extension.json": (source / "extension.json").read_bytes(),
"lfx_loom/components/loom/loom_component.py": (source / "loom_component.py").read_bytes(),
}
temporary = Path(os.environ["RUNNER_TEMP"])
for directory in ("lfx-dist", "lfx-rebuilt"):
wheel = only(temporary / directory, "*.whl")
check_wheel(wheel, expected, (source / "LICENSE").read_bytes())
with zipfile.ZipFile(wheel) as archive:
names = [name for name in archive.namelist() if name.endswith(".dist-info/METADATA")]
assert len(names) == 1
metadata = BytesParser().parsebytes(archive.read(names[0]))
assert metadata["Name"] == project["name"]
assert metadata["Version"] == project["version"]
assert set(metadata["Requires-Python"].split(",")) == set(project["requires-python"].split(","))
assert set(metadata.get_all("Requires-Dist")) == {"lfx==1.13.3", "clickhouse-loom<2,>=1.2.0"}
check_sdist(only(temporary / "lfx-dist", "*.tar.gz"), source)
PY
cd "$RUNNER_TEMP/lfx-dist"
sha256sum ./*.whl ./*.tar.gz > SHA256SUMS
- uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
with:
name: lfx-loom-distributions
path: ${{ runner.temp }}/lfx-dist/
if-no-files-found: error
retention-days: 14

install:
needs: build
runs-on: ubuntu-latest
timeout-minutes: 15
strategy:
fail-fast: false
matrix:
sdk: ["clickhouse-loom==1.2.0", "clickhouse-loom"]
steps:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
- uses: actions/setup-python@6d4fd22b20465ccc0f7354476588e8df7c9ca0e0 # v7.1.0
with:
python-version: "3.11"
- uses: astral-sh/setup-uv@68559e99cc807c1eb7e9238fd43a15bba460eec2 # v10.3.3
with:
version: "0.12.19"
- uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
with:
name: lfx-loom-distributions
path: ${{ runner.temp }}/lfx-dist/
- name: Install the extension with published dependencies
env:
SDK_REQUIREMENT: ${{ matrix.sdk }}
run: |
cd "$RUNNER_TEMP/lfx-dist"
sha256sum --check SHA256SUMS
uv venv --python 3.11 "$RUNNER_TEMP/lfx-env"
uv pip install --python "$RUNNER_TEMP/lfx-env/bin/python" ./*.whl "$SDK_REQUIREMENT"
uv pip check --python "$RUNNER_TEMP/lfx-env/bin/python"
- name: Discover and load the installed extension
env:
SDK_REQUIREMENT: ${{ matrix.sdk }}
run: |
cp scripts/gates/langflow_extension_smoke.py "$RUNNER_TEMP/lfx-checks.py"
cd "$RUNNER_TEMP"
"$RUNNER_TEMP/lfx-env/bin/python" - <<'PY'
from importlib import metadata
import json
import os
from pathlib import Path
import runpy
import sys

checks = runpy.run_path("lfx-checks.py")
source = Path(os.environ["GITHUB_WORKSPACE"]) / "integrations/langflow"
component = (source / "loom_component.py").read_bytes()
expected = {
"lfx_loom/__init__.py": (source / "src/lfx_loom/__init__.py").read_bytes(),
"lfx_loom/extension.json": (source / "extension.json").read_bytes(),
"lfx_loom/components/loom/loom_component.py": component,
}
assert metadata.version("lfx") == "1.13.3"
sdk = metadata.version("clickhouse-loom")
if os.environ["SDK_REQUIREMENT"] == "clickhouse-loom==1.2.0":
assert sdk == "1.2.0"
installed = checks["check_installed"](expected, Path(sys.prefix).resolve())
component_id = checks["check_discovery"](installed, component)
print(json.dumps({"extension": installed.version, "clickhouse-loom": sdk,
"component": component_id, "scope": "installed discovery; no tool calls or live flow"}))
PY

publish:
if: github.event_name == 'push' && github.ref_type == 'tag'
needs: [build, install]
runs-on: ubuntu-latest
timeout-minutes: 10
environment:
name: pypi-lfx-loom
url: https://pypi.org/p/lfx-loom
permissions:
contents: read
id-token: write
steps:
- uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
with:
name: lfx-loom-distributions
path: release/
- name: Verify the checked distributions
run: |
cd release
sha256sum --check SHA256SUMS
rm SHA256SUMS
- name: Publish the checked wheel and sdist with attestations
uses: pypa/gh-action-pypi-publish@7245906fb61fa33a13554f9d5fb856fe61758086 # v1.14.3
with:
packages-dir: release/
23 changes: 23 additions & 0 deletions integrations/langflow/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,29 @@ the checkout's SDK wheel in an isolated environment, and checks manifest discove
source bytes and class loading. Those checks do not invoke the component or run a
live flow. A live Langflow flow has not been qualified.

## Publish the extension

The extension has its own package version and publication workflow. A tag named
`lfx-loom-v<version>` must match the stable version in both `pyproject.toml` and
`extension.json`. The package workflow checks the wheel, source archive and
rebuilt wheel, then installs the wheel with published dependencies and checks
LFX discovery. It tests both SDK 1.2.0 and the current dependency resolution and
records the resolved SDK version. These checks do not invoke a component or run
a live flow.

PyPI trusted publishing must authorize the `ClickHouse/loom` repository,
`langflow-publish.yml` workflow and `pypi-lfx-loom` environment for `lfx-loom`.
For a package that has not been created, configure a pending publisher in the
authorized PyPI account. The GitHub environment's publication restrictions must
allow the extension tag. Account and environment access are separate from the
core SDK publisher.

After the source review and required CI pass, publish an immutable matching tag
on the merged workflow commit through the repository's normal tag process. A
refused push stops publication. The publish job uses only the checked build
artifacts and supplies PyPI attestations. Verify the public version, anonymous
installation, file digests and provenance before describing it as published.

## Load the custom component

The manual custom-component route targets Langflow 1.13.3. Install the SDK in the
Expand Down
95 changes: 95 additions & 0 deletions tests/unit/test_langflow_publication.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
"""Independent extension tags must match both package manifests."""

from __future__ import annotations

import json
import os
import subprocess
import sys
from pathlib import Path

import pytest
import yaml

ROOT = Path(__file__).resolve().parents[2]


@pytest.mark.parametrize(
("tag", "version", "manifest_version", "name", "accepted"),
[
("lfx-loom-v0.1.0", "0.1.0", "0.1.0", "lfx-loom", True),
("lfx-loom-v2.4.6", "2.4.6", "2.4.6", "lfx-loom", True),
("lfx-loom-v0.1.1", "0.1.0", "0.1.0", "lfx-loom", False),
("lfx-loom-v0.1.0", "0.1.0", "0.2.0", "lfx-loom", False),
("lfx-loom-v0.1.0", "0.1.0", "0.1.0", "another-project", False),
("lfx-loom-v0.1.0-rc.1", "0.1.0", "0.1.0", "lfx-loom", False),
("lfx-loom-v0.1.0", "0.1.0rc1", "0.1.0rc1", "lfx-loom", False),
("lfx-loom-v01.1.0", "01.1.0", "01.1.0", "lfx-loom", False),
("lfx-loom-v0.1", "0.1", "0.1", "lfx-loom", False),
("v1.3.0", "0.1.0", "0.1.0", "lfx-loom", False),
("lfx-loom-v0.1.0; exit 0", "0.1.0", "0.1.0", "lfx-loom", False),
],
)
def test_tag_identifies_the_extension_in_both_manifests(
tmp_path: Path, tag: str, version: str, manifest_version: str, name: str, accepted: bool
) -> None:
workflow = yaml.safe_load((ROOT / ".github/workflows/langflow-publish.yml").read_text())
guard = next(
step["run"]
for step in workflow["jobs"]["build"]["steps"]
if step.get("id") == "publication-tag"
)
source = tmp_path / "integrations/langflow"
source.mkdir(parents=True)
(source / "pyproject.toml").write_text(f'[project]\nname = "{name}"\nversion = "{version}"\n')
(source / "extension.json").write_text(
json.dumps({"id": "lfx-loom", "version": manifest_version})
)
search_path = str(Path(sys.executable).parent) + os.pathsep + os.environ["PATH"]
result = subprocess.run(
["bash", "-euo", "pipefail", "-c", guard],
cwd=tmp_path,
env={**os.environ, "RELEASE_TAG": tag, "IS_TAG": "true", "PATH": search_path},
capture_output=True,
text=True,
timeout=5,
)
assert (result.returncode == 0) is accepted, result.stderr


@pytest.mark.parametrize("on_main", [True, False])
def test_publication_rejects_a_commit_not_shipped_on_main(tmp_path: Path, on_main: bool) -> None:
workflow = yaml.safe_load((ROOT / ".github/workflows/langflow-publish.yml").read_text())
guard = next(
step["run"]
for step in workflow["jobs"]["build"]["steps"]
if step.get("id") == "publication-source"
)
commit = [
"git",
"-c",
"user.name=Fixture",
"-c",
"user.email=fixture@example.com",
"commit",
"--quiet",
"--allow-empty",
"-m",
"fixture",
]
for command in (
["git", "init", "--quiet"],
commit,
["git", "update-ref", "refs/remotes/origin/main", "HEAD"],
):
subprocess.run(command, cwd=tmp_path, check=True, capture_output=True, timeout=5)
if not on_main:
subprocess.run(commit, cwd=tmp_path, check=True, capture_output=True, timeout=5)
result = subprocess.run(
["bash", "-euo", "pipefail", "-c", guard],
cwd=tmp_path,
capture_output=True,
text=True,
timeout=5,
)
assert (result.returncode == 0) is on_main, result.stderr
Loading