Add per-script and plugin versioning with changelog rules
This commit is contained in:
@@ -2,6 +2,8 @@
|
||||
|
||||
Combined working repo for the TWS Plutonium Zombies scripts and native plugins across two games.
|
||||
|
||||
[Changelog](CHANGELOG.md) · [Current component versions](versions.json)
|
||||
|
||||
## Layout
|
||||
|
||||
- [t5/scripts/](t5/scripts/) — T5 GSC modules, [README](t5/scripts/README.md), and [notes](t5/scripts/NOTES.md).
|
||||
@@ -12,6 +14,40 @@ Combined working repo for the TWS Plutonium Zombies scripts and native plugins a
|
||||
The scripts still deploy to the game's existing `storage/t5/scripts/sp/` or
|
||||
`storage/t6/scripts/zm/` directories; the new source layout does not change GSC namespaces.
|
||||
|
||||
## Versioning
|
||||
|
||||
[versions.json](versions.json) records the current source version of each
|
||||
individual script and each native plugin. Every `.gsc` file has its own version,
|
||||
keyed by its exact filename. Changing one script bumps only that script's version;
|
||||
other scripts increase only when their own source changes.
|
||||
|
||||
| Component | Manifest key | Source |
|
||||
| --- | --- | --- |
|
||||
| Each T5 script | Exact filename, e.g. `tws_t5_afk.gsc` | Corresponding file in `t5/scripts/` |
|
||||
| Each T6 script | Exact filename, e.g. `tws_t6_afk.gsc` | Corresponding file in `t6/scripts/` |
|
||||
| T5 plugin | `t5-plugin` | `t5/plugins/tws-t5-gsc-utils/` |
|
||||
| T6 plugin | `t6-plugin` | `t6/plugins/tws-t6-gsc-utils/` |
|
||||
|
||||
Every completed script or plugin change includes a version bump for each
|
||||
affected component and an entry in [CHANGELOG.md](CHANGELOG.md). Each entry
|
||||
identifies each changed script or plugin and its new version, compatibility
|
||||
requirements, and deployment steps. Shared helpers such as `tws_t5_common.gsc`
|
||||
have their own versions; document required dependency versions when compatibility
|
||||
changes. A shared helper change alone does not bump its unchanged consumers.
|
||||
Changes to shared build/dependency tooling also bump the plugins they affect.
|
||||
|
||||
Versions use `MAJOR.MINOR.PATCH`: increase the patch for fixes and internal
|
||||
changes, the minor for compatible features, and the major for breaking changes
|
||||
to commands, configuration, native APIs, or data contracts. Reset lower fields
|
||||
when increasing the minor or major. Bump once per logical change; documentation-only
|
||||
and test-only changes are exempt. All 14 scripts and both plugins advance independently.
|
||||
|
||||
The initial `1.0.0` versions document the existing source baseline. These TWS
|
||||
versions are separate from upstream revisions in each plugin's `upstream.json`
|
||||
and the existing native loader `plugin_version()` value. Component versions
|
||||
identify source changes; consult the changelog for compatible script/plugin
|
||||
combinations and receiver requirements. Maintenance rules are in [AGENTS.md](AGENTS.md).
|
||||
|
||||
## Building plugins
|
||||
|
||||
Plugin source is vendored as regular tracked files so local modifications travel
|
||||
|
||||
Reference in New Issue
Block a user