Skip to content

Commit 74b49a9

Browse files
committed
fix: correct contrib template release guidance
1 parent 6d826a3 commit 74b49a9

2 files changed

Lines changed: 20 additions & 6 deletions

File tree

evaluators/contrib/template/README.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,10 @@ The template uses `{{NAME}}` for that package identifier. It does not use `{{ORG
3737
- `{{CLASS}}` -> evaluator class name
3838
- `{{AUTHOR}}` -> authoring team
3939

40-
Then confirm the package `version` reflects your release plan and that the
40+
The template starts new packages at `0.1.0`; change that if your release plan differs.
41+
Also replace the copied `README.md` with package-specific install, configuration, and usage
42+
docs before your first build or publish. Then confirm the package `version` reflects your
43+
release plan and that the
4144
`agent-control-evaluators` / `agent-control-models` dependency floors still match the
4245
compatibility floor used by the existing contrib packages and builtin extras (currently
4346
`>=3.0.0`) before you commit the new package.
@@ -90,11 +93,22 @@ After the new package exists as a real contrib package, wire it into the repo co
9093
agent-control-evaluator-<name> = { path = "../contrib/<name>", editable = true }
9194
```
9295

93-
3. Add the package to the root semantic-release version train in `pyproject.toml`:
96+
3. If this package should publish on the repo-managed release train, wire all of the release
97+
automation together:
9498

95-
```toml
96-
"evaluators/contrib/<name>/pyproject.toml:project.version",
97-
```
99+
- Add the package to `tool.semantic_release.version_toml` in the root `pyproject.toml`:
100+
101+
```toml
102+
"evaluators/contrib/<name>/pyproject.toml:project.version",
103+
```
104+
105+
- Add a build target for the package in `scripts/build.py`, and include it in the release
106+
workflow's build step.
107+
108+
- Add a publish/upload step for the package in `.github/workflows/release.yaml`.
109+
110+
If the contrib package will be versioned and published independently, skip the repo release
111+
train wiring and keep its versioning/publishing automation local to that package.
98112

99113
Until those steps are done, the package is still scaffolding rather than a real contrib package.
100114

evaluators/contrib/template/pyproject.toml.template

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
22
name = "agent-control-evaluator-{{NAME}}"
3-
version = "7.5.0"
3+
version = "0.1.0"
44
description = "{{NAME}} evaluators for agent-control"
55
readme = "README.md"
66
requires-python = ">=3.12"

0 commit comments

Comments
 (0)