docs-release

docs-release is a cursor rule for Cursor from inventwo/ioBroker.life360ng. It costs 0 tokens per session (537 once invoked), scanned A, original, MIT.

A set of rules for keeping a project's README, documentation, changelog, and release process up to date. A changelog records features and fixes included in each release.

In plain words
What is it for?
Use it when adding features, changing configuration, updating user instructions, or preparing a release. It covers English and German documentation, changelog entries, and release commands.
Why use it?
It prevents documentation from becoming inconsistent with the software or its settings. It also standardizes release notes and requires changes to be recorded during development.

Cursor rule for Cursor

Written for Cursor: installed under .cursor/.

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add rules/inventwo/iobroker.life360ng/docs-release
Clone the repo
git clone --depth 1 https://github.com/inventwo/ioBroker.life360ng

Made for: Cursor.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for docs-release

README.md
[![agentmods](https://agentmods.dev/badge/rules/inventwo/iobroker.life360ng/docs-release.svg)](https://agentmods.dev/rules/inventwo/iobroker.life360ng/docs-release)
Your own site
<a href="https://agentmods.dev/rules/inventwo/iobroker.life360ng/docs-release"><img src="https://agentmods.dev/badge/rules/inventwo/iobroker.life360ng/docs-release.svg" alt="Measured on agentmods" height="20"></a>
Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 537 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00000 $0.00537
Opus 5 $0.00000 $0.00269
Sonnet 5 $0.00000 $0.00107
Haiku 4.5 $0.00000 $0.00054

Measured 6d ago against content hash 04d45abf636c, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-06, from the pricing page.

Security

Grade A, and why

docs-release scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 6d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

Origin

Copies of this mod

1 near-identical copy found in the catalogue:

.cursor/rules/docs-release.mdc · 68 lines

How it starts

The opening of the file, as written. The whole thing — 68 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Documentation & Releases

README (English only — ioBroker requirement)

Required sections: Installation, Configuration, Usage, Changelog, License, Support.

  • All content in English — no German or other languages in README.md
  • User-facing language; reference issues as fixes #XX
  • Update Configuration/Usage/Data Points when admin options or behavior change

Extended documentation (mandatory for features & config changes)

When adding features or changing admin configuration, update all of:

  1. docs/en/ — English documentation
  2. docs/de/ — German documentation
  3. README.md — main documentation

Documentation must reflect the actual admin UI and runtime behavior.

Changelog format

<!--
  ### **WORK IN PROGRESS**
-->

### **WORK IN PROGRESS**

- (skvarel) Plain user-facing description in English

### 1.11.0 (2026-05-28)
- (skvarel) Released change

Workflow

  • During development: all entries under ### **WORK IN PROGRESS**
  • Every fix or feature: add a changelog entry — no exceptions
  • Release: npm run release-patch|minor|major — script sets version, moves WIP to version block
  • Never edit CHANGELOG_OLD.md manually
  • Never use bold type tags in changelog lines (breaks io-package news translation)

io-package.json

  • Keep common.version in sync with package.json
  • New config options: add to native with defaults

CI/CD

Official ioBroker test actions (see .github/workflows/test-and-release.yml):

  • ioBroker/testing-action-check@v1 — lint + package check (lint-first)
  • ioBroker/testing-action-adapter@v1 — adapter tests (Node 22.x, 24.x; ubuntu/windows/macos)
  • ioBroker/testing-action-deploy@v1 — npm deploy on version tags (OIDC, when enabled)

Job order: check-and-lint (no deps) → adapter-tests.

CI runs lint: true only — no type-checking unless the workflow is changed.

Credential/API tests: separate from main suite; not required for deployment; use 120+ s timeouts for external calls.

Read the full file on GitHub · 68 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 6d ago First seen · 68 lines · 0 tokens per session scan A 04d45abf636c

Subscribe to this mod's changes

docs-release is a cursor rule published in the GitHub repository inventwo/ioBroker.life360ng (4 stars, last pushed 12d ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 537 tokens. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.