-
-
Notifications
You must be signed in to change notification settings - Fork 555
Creating a prod stable release
This is intended for maintainers only
To create a prod/stable release, first go to https://github.com/portapack-mayhem/mayhem-firmware/tree/next/.github/workflows and edit the past_version.txt
and the version.txt
files.
-
past_version.txt
needs to be the current release (I.E if you are creating a new release and the old/current stable release isv1.0.0
and you want the new version to bev1.1.0
, then past version needs to bev1.0.0
). -
version.txt
needs to be the version you want for your new release. So from the example above, that would bev1.1.0
.
Once that is done then you need to create the draft stable release. You can do this by running the stable release pipeline on next
branch https://github.com/portapack-mayhem/mayhem-firmware/actions/workflows/create_stable_release.yml
This should take around 7-15 minutes.
This then creates a draft release that you should be able to see in releases at the top https://github.com/portapack-mayhem/mayhem-firmware/releases
Next, make sure you test it on your own device before going any further. This is to ensure it created it correctly and that there are no last minute bugs.
Once all is done, create a PR to merge the next
branch into the master
branch.
Take a quick look over the draft release and make sure everything looks good, If it does go ahead an publish it!
Then make sure to create an announcement on Discord that vx.x.x has just been released and post a link to it.
Note
The wiki is incomplete. Please add content and collaborate.
Important
- This is a public wiki. Everything is visible to everyone. Don't use it for personal notes.
- Avoid linking to external tutorials/articles; they may become outdated or contain false information.
How to collaborate
How to ask questions correctly
- First steps
- Usage cautions
- Intended use and Legality
- Features
- PortaPack Versions (which one to buy)
- HackRF Versions
- Firmware update procedure
- Description of the hardware
- User interface
- Powering the PortaPack
- Troubleshooting
- Applications
-
Compilation of the firmware
- Compile on WSL with ninja
- How to compile on Windows faster with WSL 2
- Using Docker and Kitematic
- Docker command-line reference
- Using Buddyworks and other CI platforms
- Notes for Buddy.Works (and other CI platforms)
- Using ARM on Debian host
- All in one script for ARM on Debian host
- Compile on Arch based distro (exclude Asahi)
- Dev build versions
- Notes About ccache
- Create a custom map
- Code formatting
- PR process
- Description of the Structure
- Software Dev Guides
- Tools
- Research
- UI Screenshots
- Maintaining
- Creating a prod/stable release (Maintainers only)
- Maintaining rules
- Development States Notes