File contents Release Guide
🚀 Automated Release Process
Releases are now fully automated when PRs are merged to the main branch.
📋 How Releases Work
1. Automatic Release Creation
Trigger : Any merge to main branchVersion : Automatically uses version from src/local_deep_research/__version__.pyChangelog : Auto-generated from commit history since last releaseNo duplicates : Skips if release already exists for that version
2. Automatic Publishing (with approval)
GitHub Release → triggers:
PyPI publishing (requires release environment approval)Docker publishing (requires release environment approval)
👥 Who Can Release
Code owners (defined in .github/CODEOWNERS):
@LearningCircuit@hashedviking@djpetti
📝 Release Workflow
For Regular Releases:
Create PR with your changesUpdate version in src/local_deep_research/__version__.pyGet approval from code ownersMerge to main → Release automatically createdApprove publishing in GitHub Actions (PyPI/Docker)
For Hotfixes:
Create hotfix branch from mainMake minimal fix Bump patch version (e.g., 0.4.3 → 0.4.4)Fast-track review by code ownersMerge to main → Automatic release
🔧 Manual Release Options
Option A: Manual Trigger
Go to Actions → "Create Release" → "Run workflow"
Specify version and prerelease flag
Option B: Version Tags
git tag v0.4.3 && git push origin v0.4.3Automatically creates release
🛡️ Branch Protection
Main branch is protectedRequired reviews from code ownersNo direct pushes - only via approved PRsStatus checks must pass (CI tests)
📦 Version Numbering
Follow Semantic Versioning :
Major (X.0.0): Breaking changesMinor (0.X.0): New features, backward compatiblePatch (0.0.X): Bug fixes, backward compatible
🚨 Emergency Procedures
If automation fails:
Manual GitHub release still triggers PyPI/DockerContact code owners for assistanceCheck workflow logs in GitHub Actions
📊 Release Checklist
1 --- 2 name: 274-release-guide-99495a39 3 description: Release Guide 4 --- 5 # Release Guide 6 7 ## 🚀 Automated Release Process 8 9 Releases are now **fully automated** when PRs are merged to the `main` branch. 10 11 ## 📋 How Releases Work 12 13 ### 1. **Automatic Release Creation** 14 - **Trigger**: Any merge to `main` branch 15 - **Version**: Automatically uses version from `src/local_deep_research/__version__.py` 16 - **Changelog**: Auto-generated from commit history since last release 17 - **No duplicates**: Skips if release already exists for that version 18 19 ### 2. **Automatic Publishing** (with approval) 20 - **GitHub Release** → triggers: 21 - **PyPI publishing** (requires `release` environment approval) 22 - **Docker publishing** (requires `release` environment approval) 23 24 ## 👥 Who Can Release 25 26 Code owners (defined in `.github/CODEOWNERS`): 27 - `@LearningCircuit` 28 - `@hashedviking` 29 - `@djpetti` 30 31 ## 📝 Release Workflow 32 33 ### For Regular Releases: 34 35 1. **Create PR** with your changes 36 2. **Update version** in `src/local_deep_research/__version__.py` 37 3. **Get approval** from code owners 38 4. **Merge to main** → Release automatically created 39 5. **Approve publishing** in GitHub Actions (PyPI/Docker) 40 41 ### For Hotfixes: 42 43 1. **Create hotfix branch** from main 44 2. **Make minimal fix** 45 3. **Bump patch version** (e.g., 0.4.3 → 0.4.4) 46 4. **Fast-track review** by code owners 47 5. **Merge to main** → Automatic release 48 49 ## 🔧 Manual Release Options 50 51 ### Option A: Manual Trigger 52 - Go to Actions → "Create Release" → "Run workflow" 53 - Specify version and prerelease flag 54 55 ### Option B: Version Tags 56 - `git tag v0.4.3 && git push origin v0.4.3` 57 - Automatically creates release 58 59 ## 🛡️ Branch Protection 60 61 - **Main branch** is protected 62 - **Required reviews** from code owners 63 - **No direct pushes** - only via approved PRs 64 - **Status checks** must pass (CI tests) 65 66 ## 📦 Version Numbering 67 68 Follow [Semantic Versioning](https://semver.org/): 69 - **Major** (X.0.0): Breaking changes 70 - **Minor** (0.X.0): New features, backward compatible 71 - **Patch** (0.0.X): Bug fixes, backward compatible 72 73 ## 🚨 Emergency Procedures 74 75 If automation fails: 76 1. **Manual GitHub release** still triggers PyPI/Docker 77 2. **Contact code owners** for assistance 78 3. **Check workflow logs** in GitHub Actions 79 80 ## 📊 Release Checklist 81 82 - [ ] Version updated in `__version__.py` 83 - [ ] Changes tested in PR 84 - [ ] Code owner approval received 85 - [ ] CI tests passing 86 - [ ] Merge to main completed 87 - [ ] Release automatically created 88 - [ ] PyPI/Docker publishing approved
commit eab443542d
Frequently asked questions How do I install the 274 Release Guide 99495a39 skill? Run npx skillmds@latest add tools-only/274-release-guide-99495a39 in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.
What does the 274 Release Guide 99495a39 skill do? Release Guide It is listed under Productivity on SkillMD.
Is 274 Release Guide 99495a39 safe to use? This skill has not completed SkillMD's automated safety review yet. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.
Which AI agents work with 274 Release Guide 99495a39? This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.
Is 274 Release Guide 99495a39 free to use? Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.
Who published 274 Release Guide 99495a39? tools-only (@tools-only) published this skill. Their other Agent Skills are listed on their SkillMD profile.
tools-only