Skip to content

Commit 165b89c

Browse files
committed
fix: address code review feedback on migration tooling
- Fix 8.1.0 manifest from field (was 7.10.0, should be 8.0.0) - Add default field to env_variable schema in author skill - Clarify pr field guidance (include wherever a PR exists) - Document release tag convention in CLAUDE.md
1 parent 72b0df5 commit 165b89c

3 files changed

Lines changed: 8 additions & 3 deletions

File tree

.claude/skills/author-migration/SKILL.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ Check `.env*` files for changes:
106106
git diff <previous-tag>..<current-ref> -- packages/app/.env*
107107
```
108108

109-
Document each added, removed, or changed variable with its name and whether it is required.
109+
Document each added, removed, or changed variable with its name, whether it is required, and optionally a default value (from `.env.example` or the `.env` file in the diff). The `default` field is recommended wherever a sensible default exists; omit it when the value is project-specific.
110110

111111
#### 3e. `new_file` — Newly added files
112112

@@ -188,12 +188,13 @@ changes: # Array of change entries
188188
variables:
189189
- name: "VARIABLE_NAME"
190190
required: true | false
191+
default: "optional-default-value" # optional — if present, the migration plugin uses this as the initial value
191192
```
192193
193194
#### Key rules for the manifest
194195
195196
- **File paths are ALWAYS relative to the app package root** — use `src/...` not `packages/app/src/...`. Strip the `packages/app/` prefix from all paths.
196-
- **PR links** should be extracted from commit messages where possible.
197+
- **PR links** should be included wherever a PR exists. Omit only for changes that span multiple PRs or were direct pushes without a PR.
197198
- **`scope: project_wide`** on dependency_migration means downstream code using that library may need changes. **`scope: package`** means just bumping the version is sufficient.
198199
- **Group related changes** — if multiple files were changed in the same PR/feature, put them in a single `file_tracking` entry with multiple files.
199200
- **Order changes** by type: infrastructure first, then dependency_migration (major/project_wide before minor/package), then new_file, file_removal, file_tracking, translation, env_variable.

CLAUDE.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,10 @@ Multiple projects are built on top of this repo. They install `essencium-lib` an
1919

2020
When this repo releases a new version, downstream projects need to migrate. Migration manifests in `packages/app/manifests/` describe what changed per release. The `/author-migration` skill (in `.claude/skills/`) helps generate these manifests. A separate [migration plugin](https://github.com/Frachtwerk/essencium-frontend-migration-plugin) helps downstream projects apply the changes.
2121

22+
## Release tags
23+
24+
Release tags follow the pattern `essencium-app-vX.Y.Z` (e.g., `essencium-app-v9.5.0`).
25+
2226
## Commands
2327

2428
- `pnpm build` — Build all packages

packages/app/manifests/8.1.0.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
version: "8.1.0"
2-
from: "7.10.0"
2+
from: "8.0.0"
33
date: "2025-03-27"
44

55
changes:

0 commit comments

Comments
 (0)