Skip to content

Commit 9910bfe

Browse files
authored
Remove template from public catalog (#45)
1 parent d805c54 commit 9910bfe

4 files changed

Lines changed: 13 additions & 36 deletions

File tree

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ check: check-plugin-docs check-catalog check-package-index check-codeowners chec
113113
all: lint test validate check docs
114114

115115
# ── Release ─────────────────────────────────────────────────────────────
116-
# Usage: make release PLUGIN=data-designer-template
116+
# Usage: make release PLUGIN=data-designer-my-plugin
117117

118118
PLUGIN ?=
119119
PART ?= patch

catalog/plugins.json

Lines changed: 0 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -73,38 +73,6 @@
7373
}
7474
}
7575
]
76-
},
77-
{
78-
"name": "data-designer-template",
79-
"description": "Template Data Designer plugin \u2014 text transform column generator",
80-
"install": {
81-
"requirement": "data-designer-template",
82-
"index_url": "https://nvidia-nemo.github.io/DataDesignerPlugins/simple/"
83-
},
84-
"compatibility": {
85-
"python": {
86-
"specifier": ">=3.10"
87-
},
88-
"data_designer": {
89-
"requirement": "data-designer>=0.5.7",
90-
"specifier": ">=0.5.7",
91-
"marker": null
92-
}
93-
},
94-
"docs": {
95-
"url": "https://nvidia-nemo.github.io/DataDesignerPlugins/plugins/data-designer-template/"
96-
},
97-
"plugins": [
98-
{
99-
"name": "text-transform",
100-
"plugin_type": "column-generator",
101-
"entry_point": {
102-
"group": "data_designer.plugins",
103-
"name": "text-transform",
104-
"value": "data_designer_template.plugin:plugin"
105-
}
106-
}
107-
]
10876
}
10977
]
11078
}

devtools/ddp/tests/test_catalog.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -859,3 +859,9 @@ def test_checked_in_nvidia_catalog_uses_static_package_index() -> None:
859859
assert {
860860
package["install"]["index_url"] for package in output["packages"] if isinstance(package.get("install"), dict)
861861
} == {"https://nvidia-nemo.github.io/DataDesignerPlugins/simple/"}
862+
863+
864+
def test_checked_in_nvidia_catalog_excludes_template_package() -> None:
865+
output = json.loads(catalog.PLUGINS_CATALOG_PATH.read_text(encoding="utf-8"))
866+
867+
assert "data-designer-template" not in {package["name"] for package in output["packages"]}

devtools/ddp/tests/test_validate_release.py

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -328,14 +328,17 @@ def test_release_ref_template_mismatch_fails(tmp_path: Path) -> None:
328328
assert any("release-ref-template" in error and "release/data-designer-example/0.1.0" in error for error in errors)
329329

330330

331-
def test_valid_template_plugin_passes() -> None:
332-
"""validate_release should pass for the template plugin with its actual version."""
331+
def test_template_plugin_is_not_publicly_cataloged() -> None:
332+
"""The reference template should stay out of the public catalog."""
333333
root = find_repo_root()
334+
catalog_document = json.loads((root / "catalog" / "plugins.json").read_text(encoding="utf-8"))
335+
assert "data-designer-template" not in {package["name"] for package in catalog_document["packages"]}
336+
334337
data = load_toml(root / "plugins" / "data-designer-template" / "pyproject.toml")
335338
version = data["project"]["version"]
336339

337340
result = main(["data-designer-template", version])
338-
assert result == 0
341+
assert result == 1
339342

340343

341344
def test_wrong_version_fails() -> None:

0 commit comments

Comments
 (0)