Skip to content

docs: document the release process - #6180

Closed
mday-io wants to merge 2 commits into
SQLMesh:mainfrom
mday-io:mday/releasing-doc
Closed

mday-io wants to merge 2 commits into
SQLMesh:mainfrom
mday-io:mday/releasing-doc

Conversation

@mday-io

@mday-io mday-io commented Nov 1, 2026 •

Copy link
Copy Markdown
Collaborator

Description

The repo has release workflows but no written process. CONTRIBUTING.md, GOVERNANCE.md and docs/ don't say how to cut a release. This PR documents how releases work.

  • RELEASING.md covers the three packages we publish:
    • sqlmesh on PyPI, released by pushing a v*.*.* tag
    • the VS Code extension, released by running a workflow by hand
    • @tobikodata/sqlmesh-common on npm, released by running a workflow by hand
  • CONTRIBUTING.md gets a short "Releases" section that links to the new file.

Depends on #6178

The "Release Notes" section and step 6 describe how releases work after #6178:

  • Labels are applied automatically from PR titles. A ! in the title puts the PR under Breaking changes.
  • The workflow creates draft GitHub releases. Step 6 is to add upgrade notes and then publish the draft.

This PR no longer adds .github/release.yml. #6178 owns that file. The two PRs merge cleanly in either order, but this one should merge after #6178 or at the same time, so the doc never describes behavior that isn't there yet. I'm keeping it as a draft until then.

Open questions for the TSC

The doc describes how releases work and doesn't set policy. These still need a decision:

  1. Who may push release tags. Any account that can push a v* tag publishes to PyPI with no approval step. Options include:
    • a tag ruleset limiting who can create v* tags
    • a GitHub environment with required reviewers on the publish job
    • PyPI Trusted Publishing, which also removes the TWINE_PASSWORD secret
  2. When to bump the minor version. Every recent release is a 0.236.x patch, including ones with features and breaking fixes.
  3. Whether to keep the tobiko-private upload. make publish-tests still publishes the test package to the private registry from the Tobiko era.

Test Plan

Docs only.

Checklist

  • I have run make style and fixed any issues (not applicable: no Python changes)
  • I have added tests for my changes (not applicable)
  • All existing tests pass (make fast-test) (not applicable)
  • My commits are signed off (git commit -s) per the DCO

Add RELEASING.md with the steps for the Python package, the VS Code
extension and the shared web package, and link it from CONTRIBUTING.md.

Add .github/release.yml so generated release notes list breaking
changes and dependency updates in their own sections.

Signed-off-by: mday-io <mdaytn@gmail.com>
@coderabbitai

coderabbitai Bot commented Nov 1, 2026

Copy link
Copy Markdown

Important

Draft PR not reviewed

Draft PRs are not automatically reviewed by default.

  • Trigger a manual review

To automatically review draft PRs, update your CodeRabbit configuration:

reviews:
  auto_review:
    drafts: true
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

mday-io added a commit to mday-io/sqlmesh that referenced this pull request Nov 1, 2026
Match the section names that RELEASING.md (SQLMesh#6180) uses.

Signed-off-by: mday-io <mdaytn@gmail.com>
SQLMesh#6178 adds .github/release.yml with labels applied automatically from PR
titles, and creates GitHub releases as drafts. Drop this PR's simpler
release.yml so the two don't conflict, and update RELEASING.md to match:
labels come from the title, and the release step is to edit and publish
the draft.

Move the Releases section to the end of CONTRIBUTING.md so it doesn't
conflict with the PR title section SQLMesh#6178 adds.

Signed-off-by: mday-io <mdaytn@gmail.com>
@mday-io mday-io changed the title docs: document the release process and group release notes by label docs: document the release process Nov 1, 2026
mday-io added a commit to mday-io/sqlmesh that referenced this pull request Nov 1, 2026
Narrow the PR to grouping release notes by label:

- Drop the path labeler. Its engine and area labels don't feed any
  release-note section.
- Drop the Release Note section from the PR template. Nothing reads it.
- Keep creating published GitHub releases rather than drafts. Whether to
  switch to drafts is a process decision for maintainers.

Add RELEASING.md with the steps for releasing the Python package, the
VS Code extension and the shared web package, and link to it from
CONTRIBUTING.md. It was previously proposed separately in
SQLMesh#6180.

Signed-off-by: mday-io <mdaytn@gmail.com>
@mday-io

mday-io commented Nov 1, 2026

Copy link
Copy Markdown
Collaborator Author

Closing in favor of #6178, which now includes RELEASING.md along with the release-note grouping, so both can be reviewed together.


Generated by Claude Code

@mday-io mday-io closed this Nov 1, 2026
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