OpenHornet Releases - jrsteensen/OpenHornet GitHub Wiki

This page documents the OpenHornet release process.

• General Information
  • Versioning
• BetaX Lifecycle (Post-Beta1)
  • BetaX Planning Phase
  • BetaX Hardware Development Phase
  • BetaX Software Development Phase
  • BetaX Delivery Phase
• Basic Release Workflow
  • Initial Preparation
  • Compiling the Release
  • Post-Release Actions
• Release Notes
  • Title
  • Release Description
  • Breaking Changes
  • New Features
  • Bug Fixes
  • Improvements
  • Other Changes
  • New Contributors
  • Template
• Release Checklist
  • Template

• OpenHornet uses Semantic Versioning 2.0.0, i.e. v1.3.4

1. Define list of issues to be incorporated for current release.
2. Generate appropriate GitHub milestones and projects, and assign issues as required.
3. Generate appropriate base branch for beta work.
4. Divide labor as appropriate.

1. BetaX HardWare Freeze (BxHWF)
   • Process hardware related issues for BetaX HWF.
2. BetaX HardWare Documentation (BxHWD)
   • Update all mechanical and interconnect drawings as necessary.
3. BetaX Manufacturing File Generation (BxMFG)
   • Update all manufacturing files as necessary.

1. BetaX SoftWare Freeze (BxSWF)
   • Generate/Update software related issues for BetaX SWF. Testing should be accomplished before pushing changes.
2. BetaX SoftWare Testing (BxSWT)
   • Test changes as a system, complete regression testing.

1. Package Release Candidate (BxRC)
2. Review and Verify Release Candidate Package.
3. Release the Release Candidate (Bx Release)

• All references to branch are the working new milestone branch (i.e. v1.0.0-beta.2)

1. Generate an issue named <VERSION> Release Checklist.
2. Copy the release checklist template from this page into the issue, and begin filling it out.
3. Ensure all needed changes are in the working milestone branch.

1. Verify all changed drawings, MCAD and ECAD manufacturing files are in the release folder of the branch.
2. Set version milestone on Fusion models in Fusion repository, named same as release version.
3. Verify README.MD is updated in the release folder and all URLs are updated as appropriate.
4. Verify CHANGELOG.MD is updated in the release folder.
5. Verify LICENSE.MD is updated in the release folder.
6. Convert README.MD, CHANGELOG.MD, and LICENSE.MD to PDF and add to release folder.
7. Generate 3D PDF from top level Fusion Model
8. Add 3D PDF to release folder.
9. Merge branch to Master branch.
10. Manually create Release Package ZIP file to attach to the release.
11. Generate Release from Master branch, using release note template on this page, and attaching the release ZIP.

1. Generate article on website for new release with appropriate details.
2. Announce release on Discord Announcements channel.
3. Close Release issue once checklist is completed.

• Omit any sections without entries. (i.e. if no Breaking Changes, delete the Breaking Changes section.)

• Title is a h2 header consisting of the version number, prefixed with a v character, 3-5 word description of the release, and date of the release in the YYYY-MM-DD format.

This is a release of the OpenHornet Hardware Build Package. The OpenHornet Hardware Build Package contains instructions to fabricate and assembly all physical components of the simulator, including (but not limited to) structures, panels, PCBs, and cables.

<Insert summary/description of release here.>

• A complete list of breaking changes (there should be none, unless this is a major or pre-v1.0.0 version).

• Describe the new feature and when/why to use it. Add some pictures! Call out any caveats/warnings? Is it a beta feature?

• Call out any existing feature/functionality that now works as intended or expected.

• Improvements/enhancements to a workflow, performance, cost, manufacturability, or user experience

• Other miscellaneous changes that don't fit into any of the above categories. Try to leave this empty - ideally, all changes fit into the categories above

• Auto-generated new contributor list.

• Copy and paste this into the notes, and generate the automatic changelog.

v1.0.0-beta.1: OpenHornet Takes Flight! (2025-03-22) <-- Insert into title field and update as necessary.

> Description of release in plain english.

> [!NOTE]
> A sample critical note.

**Shoutout to our Ultimate Supporters: <list of Ultimate Supporters>**
## Upgrade Steps
* [ACTION REQUIRED]
* 

## Breaking Changes
* 
* 

## New Features
* 
* 

## Bug Fixes
* 
* 

## System Optimizations
* 
* 

## Other Changes
* 
* 

## New Contributors
*
*

**Full Changelog**: <link to full changelog>

## Initial Preparation
- [ ] Generate an issue named `<VERSION> Release Checklist`.
- [ ] Copy the release checklist template from this page into the issue, and begin filling it out.
- [ ] Ensure all needed changes are in the working milestone branch.

## Compiling the Release
- [ ] Verify all changed drawings, MCAD and ECAD manufacturing files are in the `release` folder of the branch.
- [ ] Set version milestone on Fusion models in Fusion repository, named same as release version.
- [ ] Verify README.MD is updated in the `release` folder and all URLs are updated as appropriate. (To include listing all ultimate supporters.)
- [ ] Verify CHANGELOG.MD is updated in the `release` folder.
- [ ] Verify LICENSE.MD is updated in the `release` folder.
- [ ] Convert README.MD, CHANGELOG.MD, and LICENSE.MD to PDF and add to `release` folder.
- [ ] Create PR summarizing changes for release.
- [ ] Merge branch to Master branch.
- [ ] Delete development (i.e. v0.2.0) branch.
- [ ] Manually create Release Package ZIP file to attach to the release.
- [ ] Generate Tag by going to `GitHub Desktop>History Tab>Right-click on PR commit to master>Create Tag>Name Tag v<version number>`
- [ ] Generate Release from Tag, using release note template on this page, and attaching the release ZIP.

## Post-Release Actions
- [ ] Generate article on website for new release with appropriate details.
- [ ] Announce release on Discord **Announcements** channel.
- [ ] Close this issue once checklist is completed.