Skip to content

[Misc] Record the dependency-upgrade commit prefix and issue description rules - #98

Open
manuelleduc wants to merge 6 commits into
masterfrom
misc-dependency-upgrade-commit-prefix
Open

[Misc] Record the dependency-upgrade commit prefix and issue description rules#98
manuelleduc wants to merge 6 commits into
masterfrom
misc-dependency-upgrade-commit-prefix

Conversation

@manuelleduc

Copy link
Copy Markdown

Two OKF gaps surfaced while bumping vue-i18n in xwiki-platform.

  • okf/conventions/commit-messages.md — dependency upgrades split on the same user-visible test as everything else: dev/peer/test-scoped is [Misc], anything in dependencies or a runtime Maven dependency needs an issue. The trap worth recording is that a shared version catalog (pnpm catalog:, a pom.xml property) hides which one it is, and one runtime declaration among several dev-only ones is enough to require the issue.
  • okf/servers/jira.md — the dependency-upgrade issue shape: summary Upgrade to <dependency> <version>, component Dependency Upgrades, description = the raw release-note URLs of every version crossed, not just the target's. Also notes that jira-cli rewrites a plain URL as [url|url], so the description has to be set over REST to stay raw.

Patch version bump (1.5.0 → 1.5.1) across the five synced fields; node scripts/validate.mjs passes.

🤖 Generated with Claude Code

https://claude.ai/code/session_01WuYezRDJKK4fPa7xLRNG5T

…ion 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.
…nical steps

* commit-messages: the body's bullets carry what distinguishes this commit, so a lone dependency
  bump needs no body at all.
…ipt dependency

* dependencies: the pnpm and node versions the build uses are pinned in the xwiki-commons parent
  pom, so the lockfile must be regenerated with that pnpm and then deduped — not with whatever
  pnpm is on PATH.
* commit-messages: a dependencies entry is runtime only if the package holding it is reached at
  runtime, so a lint or build package's own dependencies stay [Misc] — being published is not
  evidence to the contrary.
vmassol and others added 2 commits September 1, 2026 16:27
* Five manifests carry one version, so every concurrent pull request conflicted with every other one
  on those same five lines, over something that was never part of either change. The release is now
  cut on master after the merge by scripts/release.mjs, and scripts/validate.mjs fails a branch that
  touches a version field.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants