Skip to content

Document release process#2220

Merged
paul-nechifor merged 2 commits into
mainfrom
release-docs
May 22, 2026
Merged

Document release process#2220
paul-nechifor merged 2 commits into
mainfrom
release-docs

Conversation

@Dreamsorcerer
Copy link
Copy Markdown
Collaborator

@Dreamsorcerer Dreamsorcerer commented May 22, 2026

Can be iterated on and adjusted based on feedback testing it out.

When "Physical CI" is ready, the manual test will be replaced by a step in the workflow.

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 22, 2026

Greptile Summary

This PR documents the dimos release process and adds pytest-error-for-skips as a test dependency to support the --error-for-skips flag used in the pre-release checklist.

  • docs/development/releasing.md is a new runbook covering the full lifecycle: version bump, release branch creation, backport labelling, CI workflow trigger, merge-back, and cleanup — plus a dedicated patch-fix section.
  • pyproject.toml and uv.lock add pytest-error-for-skips>=2.0.2, which provides the --error-for-skips pytest flag referenced in the runbook.

Confidence Score: 4/5

The pyproject.toml and lock file changes are safe. The runbook has a few gaps that should be addressed before the first release is cut from it.

The pyproject.toml and uv.lock additions are straightforward and correct. The runbook itself has two gaps: the referenced release workflow does not yet exist (making sections 2–3 non-executable today), and the patch-fix section omits the commit/push step after uv version --bump patch, which would leave the remote branch on the old version when the workflow is triggered.

docs/development/releasing.md — the patch-fix flow is missing a commit/push step, and the release workflow it depends on is not yet in .github/workflows/.

Important Files Changed

Filename Overview
docs/development/releasing.md New release runbook covering normal releases, backports, cleanup, and patch fixes. References a release workflow that doesn't yet exist; the patch-fix section is missing a commit/push step after the version bump.
pyproject.toml Adds pytest-error-for-skips>=2.0.2 to the tests dependency group to support the --error-for-skips flag used in the release checklist.
uv.lock Lock file regenerated: adds pytest-error-for-skips 2.0.2, refreshes the exclude-newer timestamp, and drops aarch64 triton wheels that fell outside the new 7-day resolution window.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Bump version on main\nuv version --bump patch] --> B[Open PR → squash-merge to main]
    B --> C[Create release/X.Y.Z branch\nfrom origin/main]
    C --> D[Create backport label\nbackport release/X.Y.Z]
    D --> E{Backport fixes needed?}
    E -- Yes --> F[Label PR on main\nBackport bot opens cherry-pick PR]
    F --> G[Review & squash-merge backport PR]
    G --> E
    E -- No --> H[Run full test suite locally\nuv run pytest -m 'not tool' --error-for-skips]
    H --> I[Trigger release workflow\non release/X.Y.Z branch]
    I --> J[Team approves publish-pypi step]
    J --> K[Workflow creates merge-back PR\nMerge release/X.Y.Z → main]
    K --> L[Merge-commit the merge-back PR\nCreate a merge commit ONLY]
    L --> M[Verify on GitHub Releases & PyPI]
    M --> N{Keep branch for patches?}
    N -- No --> O[Rename release/X.Y.Z → archived/X.Y.Z\nthen delete]
    O --> P[Delete backport label]
    N -- Yes --> Q[Leave branch; re-cut from tag if deleted later]

    subgraph Patch Fix
        R[Re-cut branch from tag vX.Y.Z] --> S[uv version --bump patch]
        S --> T[Commit & push version bump]
        T --> U[Apply fixes]
        U --> I
    end
Loading

Reviews (2): Last reviewed commit: "Update releasing.md" | Re-trigger Greptile

Comment thread docs/development/releasing.md
Comment thread docs/development/releasing.md Outdated
@codecov
Copy link
Copy Markdown

codecov Bot commented May 22, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

📢 Thoughts on this report? Let us know!

@paul-nechifor paul-nechifor merged commit 59e99d2 into main May 22, 2026
20 checks passed
@paul-nechifor paul-nechifor deleted the release-docs branch May 22, 2026 22:21
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