Skip to content

docs: document the release cadence and policy in RELEASING.md - #182

Merged
shahariaazam merged 1 commit into
mainfrom
docs/release-policy
Sep 19, 2026
Merged

shahariaazam merged 1 commit into
mainfrom
docs/release-policy

Conversation

@shahariaazam

Copy link
Copy Markdown
Member

Linked issue

Fixes #181

Summary

The community asked for a documented release cadence. This adds a root-level RELEASING.md as the single source of truth for release policy, leaving docs/development/build-and-release.md as the reference for release mechanics.

RELEASING.md covers:

  • Schedule — weekly on Saturday, cut from whatever is on main, and only when at least one releasable change exists (features, fixes, improvements, performance, runtime dependency updates, user-visible message fixes). Docs, website, CI and plugins/ changes do not trigger a release on their own. A missed Saturday rolls over to the next.
  • Out-of-band releases — security fixes, critical bugs/regressions, Slack-side breakage and broken install/update ship as early as possible after the fix lands on main (best effort).
  • Versioning — SemVer with the 0.x convention the /release skill already applies; no pre-releases.
  • Deprecation policy — stderr warning for at least one minor release before removal, with exceptions for security, Slack-side changes and experimental features.
  • Supported versions — latest release only (consistent with SECURITY.md).
  • How releases are announced, how they reach each install method, how to see what ships next, and how to request an out-of-band release.

Cross-links so the policy is discoverable:

  • README.md — entry in the developer docs list
  • CONTRIBUTING.md — a short "When Will My Change Ship?" section
  • docs/development/build-and-release.md — pointer at the top of "Releasing" (rendered as a GitHub link on slackcli.dev by sync-docs.mjs)
  • docs/development/project-structure.md — new file listed in the root tree
  • web/src/components/Foot.astro — "Release policy" footer link

Documentation only; no code or workflow changes. No CHANGELOG entry, in line with previous docs-only PRs.

Checklist

  • The linked issue is open and carries the ready-for-pr label (constitution §1–2)
  • Change is focused on the linked issue — no unrelated edits
  • Tests added/updated, including edge cases (constitution §4) — n/a, documentation only
  • bun run type-check and bun test pass locally (551 pass, 0 fail)
  • Pre-commit hooks are installed and passing — no --no-verify, no SKIP= (constitution §5)
  • All commits are signed (constitution §5 — unsigned commits make the PR unmergeable)
  • Documentation in docs/ updated, added, or deleted as needed (constitution §7)
  • No tokens, credentials, or user data handled insecurely

@shahariaazam
shahariaazam merged commit c983001 into main Sep 19, 2026
10 checks passed
@shahariaazam
shahariaazam deleted the docs/release-policy branch September 19, 2026 12:36
vibexp-agent added a commit that referenced this pull request Sep 19, 2026
## Summary

Scheduled weekly release. Bumps `package.json` from `0.11.0` to `0.12.0`
(minor — new capabilities, no breaking changes) and promotes the
changelog.

No linked issue: a release proposes nothing new — everything below was
already reviewed and merged on `main`. Carries `no-issue-needed` per the
`pr-linked-issue` workflow's own escape hatch.

## Included since v0.11.0

User-facing:
- feat(users): add `users` command group with shared profile-field
resolver (#177)
- feat(conversations): add members list for channel membership (read)
(#176)
- feat(conversations): channel-membership write and self ops
(add/remove/join/leave) (#178)

Non-shipping (no changelog entry, do not affect the version bump):
- fix: quote slackcli skill argument hint (#179) — plugin skill file
only, not CLI behavior
- docs: sync documentation with #179 (#180)
- ci(deps): bump actions/deploy-pages (#172)
- docs(web): add the v0.11.0 release blog post (#171)
- docs: list every user-guide page (#169)
- docs: document the release cadence and policy in RELEASING.md (#182)

## Changes in this PR

- `package.json`: `0.11.0` -> `0.12.0`
- `CHANGELOG.md`: new `## [0.12.0]` section under `[Unreleased]`,
documenting the `users` command group and the `conversations` membership
commands

## Checks

- `bun run type-check`: clean
- `bun test`: 551 pass, 0 fail

## Post-merge

Once merged, the annotated tag `v0.12.0` is pushed against this commit,
which runs `release.yml` to build binaries and update the Homebrew tap.
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.

[Improvement]: Document the release cadence and policy in RELEASING.md

1 participant