Skip to content

Commit 3d73616

Browse files
committed
[Misc] Record the dependency-upgrade commit prefix and issue description rules
A dependency bump was committed as [Misc] because the dependency was declared through a pnpm catalog entry, which hides whether it is a runtime or a dev-only dependency; and the issue that replaced it linked only the target release, losing the five intermediate releases the bump crosses. * commit-messages: split dependency upgrades on the existing user-visible test — dev/peer/test-scoped is [Misc], anything in dependencies or a runtime Maven dependency needs an issue — and warn that a shared version catalog hides which one it is. * jira: add the dependency-upgrade issue shape (summary, Dependency Upgrades component, description = raw release-note URLs of every version crossed) and why that description has to go over REST.
1 parent d54c476 commit 3d73616

6 files changed

Lines changed: 22 additions & 5 deletions

File tree

.claude-plugin/marketplace.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@
66
},
77
"metadata": {
88
"description": "Shared LLM (Claude Code) configuration for XWiki org repositories",
9-
"version": "1.5.0"
9+
"version": "1.5.1"
1010
},
1111
"plugins": [
1212
{
1313
"name": "xwiki",
1414
"source": "./xwiki",
1515
"description": "Org-wide XWiki conventions, MCP servers and dev skills for all xwiki / xwiki-contrib GitHub org repos",
16-
"version": "1.5.0",
16+
"version": "1.5.1",
1717
"author": {
1818
"name": "XWiki Development Team"
1919
}

kimi.plugin.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "xwiki",
3-
"version": "1.5.0",
3+
"version": "1.5.1",
44
"description": "Org-wide XWiki conventions, MCP servers and dev skills for all xwiki / xwiki-contrib GitHub org repos",
55
"interface": {
66
"displayName": "XWiki",

opencode.jsonc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
// XWiki shared LLM configuration for opencode (https://opencode.ai).
3-
// version: 1.5.0 — keep in sync with the plugin version (see CLAUDE.md).
3+
// version: 1.5.1 — keep in sync with the plugin version (see CLAUDE.md).
44
//
55
// Paths reference this checkout through the XWIKI_LLM_HOME environment variable so this file is
66
// identical for everyone (no personal paths) and works whether it is used globally or per-project.

xwiki/.claude-plugin/plugin.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "xwiki",
33
"description": "Org-wide XWiki conventions, MCP servers and dev skills for all xwiki / xwiki-contrib GitHub org repos",
4-
"version": "1.5.0",
4+
"version": "1.5.1",
55
"author": {
66
"name": "XWiki Development Team",
77
"url": "https://xwiki.org"

xwiki/okf/conventions/commit-messages.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,13 @@ The documented format is:
3636
in any way?"*; if yes, an issue is mandatory. A batch refactoring that changes runtime behaviour
3737
across many files therefore needs an issue, referenced from every commit of the campaign — not
3838
`[Misc]`.
39+
- **Dependency upgrades split on the same test:** a dependency that only ever reaches developers —
40+
a `devDependencies`/`peerDependencies` entry, a build or test-scoped Maven dependency — is
41+
`[Misc]`; one that ships to users (declared in `dependencies`, or a runtime Maven dependency)
42+
needs an issue. Check where the dependency is actually declared before choosing: a shared version
43+
catalog (pnpm `catalog:`, a `pom.xml` property) hides that distinction, and the same artifact can
44+
be dev-only in one module and runtime in another — one runtime declaration is enough to require
45+
the issue.
3946

4047
Issue tracker is https://jira.xwiki.org (NOT GitHub Issues); see [[jira]] for access and the
4148
issue-field conventions. For the full PR/commit flow (one squashed commit per issue, PR description,

xwiki/okf/servers/jira.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,16 @@ correct. Check what the project actually exposes before insisting on a field.
5353
Write the **description in JIRA wiki markup** (`h2.`, `{{monospace}}`, `*bold*`, `* bullet`) and make
5454
it explain the **user-visible problem**, not just the code change — but mind the markup gotchas below.
5555

56+
## Dependency-upgrade issues
57+
58+
A dependency upgrade that ships to users needs its own issue (the `[Misc]` split is in
59+
[[commit-messages]]): summary `Upgrade to <dependency> <version>`, component **Dependency Upgrades**.
60+
The description is the **raw release-note URLs of every version being crossed** — one line each, from
61+
the version after the one currently declared up to the target — not just the target's; skipping the
62+
intermediates hides the changes actually being pulled in. Keep them as bare URLs, which means setting
63+
the description over REST: `jira-cli` runs a body through its Markdown converter and rewrites a plain
64+
URL as `[url|url]`.
65+
5666
## Resolving / closing an issue
5767

5868
Choose the **resolution** that matches reality and **assign the issue to yourself** as you close it

0 commit comments

Comments
 (0)