Skip to content

docs: add versioning, release and upgrade guides - #25

Merged
3m1n3nc3 merged 4 commits into
mainfrom
docs/release-and-upgrade-guides
Nov 5, 2026
Merged

3m1n3nc3 merged 4 commits into
mainfrom
docs/release-and-upgrade-guides

Conversation

@3m1n3nc3

@3m1n3nc3 3m1n3nc3 commented Nov 5, 2026 •

Copy link
Copy Markdown
Member

Covers the two roadmap items on release workflow guidance and upgrade guides between template versions.

Versioning and Releases (docs/more/releases.md)

For maintainers. Describes the process as it works today:

  • One lockstep version for every @arkstack/* package, create-arkstack and the templates.
  • When to bump minor versus patch below 1.0, and deprecating before removing.
  • The pre-release checklist, including the catch that create-arkstack downloads templates from main while pinning the last published packages.
  • How a GitHub release (bare x.y.z tag) drives publish.yml and prepare:release-version.
  • Manual publishing and bad-release recovery with scripts/release-order.mjs.

Upgrading (docs/guide/upgrading.md)

For app developers:

  • Steps to move an app between versions, and how to diff two template versions with giget or git diff across tags.
  • Version notes for 0.18 → 0.22, taken from the template diffs and changelog between tags (lang setup in 0.21, Hook renames in 0.20, realtime config and env() changes in 0.19, catalog bumps in 0.22).

Both pages are in the sidebar, and the roadmap marks the two items done. pnpm docs:build passes.

@3m1n3nc3 3m1n3nc3 self-assigned this Nov 5, 2026
@codecov

codecov Bot commented Nov 5, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@3m1n3nc3
3m1n3nc3 merged commit dd5c8ae into main Nov 5, 2026
4 checks passed
@3m1n3nc3
3m1n3nc3 deleted the docs/release-and-upgrade-guides branch November 5, 2026 13:08
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.

1 participant