chore: drop the core to 0.1.0 and restate the stability promise

The API has one set of consumers and no outside users, so declaring 1.0.0
with a stability guarantee was premature. Until 1.0.0 any minor bump may
reshape the API; the written guarantee starts there. Plugins pin 0.1.0.
This commit is contained in:
dualfroz committed 2026-08-05 20:40:32 +02:00
1 parent d8da766684
commit 39c7c12fb3
5 files changed
+29 -16

No files matched your search

+17 -6
View File
@@ -157,12 +157,13 @@ _ensureCoreOnPath()
```python ```python
from nemoRepoCore import requireCore from nemoRepoCore import requireCore
requireCore("1.0.0") requireCore("0.1.0")
``` ```
If the installed core is too old, or a major version apart, this raises and If the installed core is too old, or from a different incompatible series,
Nemo skips the extension with a clear message in the log instead of loading a this raises and Nemo skips the extension with a clear message in the log
half working one. instead of loading a half working one. See "Versioning" for what counts as a
different series while the core is still `0.x`.
### 3. Register your defaults ### 3. Register your defaults
@@ -295,14 +296,24 @@ When `error` is set, treat every other field as unknown.
Semantic versioning, enforced at load time by `requireCore`. Semantic versioning, enforced at load time by `requireCore`.
The core is at `0.1.0`, which in semver means the API is not settled yet: its
only consumers are the five plugins listed above and it has no outside users.
Until `1.0.0`, any minor bump may remove or rename anything in the API table.
`requireCore` follows the same rule and treats the minor as the breaking
component while the major is `0`, so a plugin that asked for `0.1.0` refuses to
load against `0.2.0` instead of breaking somewhere deeper.
From `1.0.0` on, the guarantee below is the written one and holds:
- Within a major version nothing in the API table is removed or renamed, and - Within a major version nothing in the API table is removed or renamed, and
signatures only ever gain optional arguments. A plugin that asked for `1.0.0` signatures only ever gain optional arguments. A plugin that asked for `1.0.0`
keeps working on `1.4.0`. keeps working on `1.4.0`.
- A major bump may change anything. `requireCore` refuses to run a plugin - A major bump may change anything. `requireCore` refuses to run a plugin
against a different major version, so the failure is loud and immediate against a different major version, so the failure is loud and immediate
rather than subtle. rather than subtle.
- Anything not in the API table, and anything with a leading underscore, is
internal. Anything not in the API table, and anything with a leading underscore, is
internal either way.
## Tested on ## Tested on
+1 -1
View File
@@ -38,7 +38,7 @@ from gi.repository import GObject, Nemo
from nemoRepoCore import (findRepoRoot, localDirectoryPath, repoCache, from nemoRepoCore import (findRepoRoot, localDirectoryPath, repoCache,
requireCore) requireCore)
requireCore("1.0.0") requireCore("0.1.0")
class LastCommitColumnProvider(GObject.GObject, Nemo.ColumnProvider, class LastCommitColumnProvider(GObject.GObject, Nemo.ColumnProvider,
+9 -7
View File
@@ -10,7 +10,7 @@ Minimal plugin:
from nemoRepoCore import (coreConfig, findRepoRoot, localDirectoryPath, from nemoRepoCore import (coreConfig, findRepoRoot, localDirectoryPath,
repoCache, requireCore) repoCache, requireCore)
requireCore("1.0.0") requireCore("0.1.0")
coreConfig.registerDefaults({"indicators": {"mine": {"enabled": True}}}) coreConfig.registerDefaults({"indicators": {"mine": {"enabled": True}}})
@@ -28,12 +28,14 @@ Minimal plugin:
Stability policy for everything listed in __all__: Stability policy for everything listed in __all__:
* Within a major version, names are never removed and signatures only ever * The core is 0.x, so the API is not settled yet: any 0.x minor bump may
gain optional arguments. New helpers may appear; a plugin that asked for remove or reshape anything. requireCore() knows this and treats the minor
1.0.0 keeps working on 1.4.0. as the breaking component while the major is 0, so a plugin that asked
* A major bump may remove or reshape anything. requireCore() refuses to for 0.1.0 refuses to load against 0.2.0 instead of misbehaving later.
load a plugin against a different major, so a mismatch is a clear error * From 1.0.0 on the usual guarantee applies: within a major version names
at startup instead of a subtle misbehaviour later. are never removed and signatures only ever gain optional arguments, so a
plugin that asked for 1.0.0 keeps working on 1.4.0, and only a major bump
may reshape anything.
* Names not in __all__, and anything with a leading underscore, are * Names not in __all__, and anything with a leading underscore, are
internal and may change in any release. internal and may change in any release.
""" """
+1 -1
View File
@@ -1,6 +1,6 @@
"""Version of the core library and the compatibility check plugins call.""" """Version of the core library and the compatibility check plugins call."""
coreVersion = "1.0.0" coreVersion = "0.1.0"
class CoreVersionError(RuntimeError): class CoreVersionError(RuntimeError):
+1 -1
View File
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
[project] [project]
name = "nemo-repo-core" name = "nemo-repo-core"
version = "1.0.0" version = "0.1.0"
description = "Shared foundation for repository-aware Nemo file manager plugins" description = "Shared foundation for repository-aware Nemo file manager plugins"
readme = "README.md" readme = "README.md"
requires-python = ">=3.8" requires-python = ">=3.8"