15 Creating a prod stable release

jLynx edited this page 2024-04-07 16:25:40 +12:00

Table of Contents

• Setting up the repo
• Running the pipeline
• Editing the draft release
• Finishing off

This is intended for maintainers only

Setting up the repo

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 is v1.0.0 and you want the new version to be v1.1.0, then past version needs to be v1.0.0).
• version.txt needs to be the version you want for your new release. So from the example above, that would be v1.1.0.

Running the pipeline

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.

Editing the draft release

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.

Finishing off

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.

Start here

How to collaborate
How to ask questions correctly

User manual

• First steps
  • About firmwares
  • Redirections on this manual/project
• Usage cautions
• Intended use and Legality
• Features
• PortaPack Versions (which one to buy)
• HackRF Versions
  • Original GSG HackRF One
  • Clifford's-version
• Firmware update procedure
  • Updating the Xilinx CPLD on hackrf board
• Description of the hardware
  • Enclosure/cases
    • 3d printed enclosure
  • Internal speaker
  • SMD buttons and caps
  • Encoder knob
  • SMA Antenna connector
• User interface
  • Splash screen
  • Title bar
  • Main menu
  • Main Controls
  • SD Card content and modification
  • Text Entry
• Powering the PortaPack
• Troubleshooting
  • Won't boot
  • Config Menu
  • Firmware upgrade
  • Diagnose firmware update in Windows
  • Receive Quality Issues
  • No TX/RX
  • TX Carrier Only
  • H2+ speaker modifications
  • Dead Coin Cell Battery
  • Factory Defaults
  • SD card not recognized by PC with the SD-card over USB selected
  • DFU overlay
  • Full reset
  • SolveBoard
• Applications
  • Receivers
    • ADS-B
    • AFSK
    • AIS Boats
    • Analog TV
    • APRS
    • Audio
    • BLE RX
    • ERT Meter
    • Level
    • NRF
    • POCSAG
    • Radiosonde
    • Recon
    • Search
    • TPMS Cars
    • Weather/SubGhzD
    • Fox-Hunt
    • ProtoView
  • Transmitters
    • ADS-B(S)
    • APRS
    • BHT Xy/EP
    • BLE TX
    • Burger Pager
    • GPS Sim
    • Jammer
    • LGE Tool
    • Morse
    • OOK
    • OOK Editor
    • POCSAG
    • RDS
    • Soundboard
    • Spectrum Painter
    • SSTV
    • TEDI/LCR
    • TouchTunes
    • BLESpam
  • Capture
    • C16 Format
  • Replay
  • Remote
  • Scanner
  • Microphone Transceiver
  • Looking Glass
  • Utilities
    • Antenna length
    • File manager
    • Freq manager
    • Notepad
    • IQ Trim
    • SD over USB
    • Signal gen
    • Wav Viewer
    • Flash Utility
    • Wipe SD card
    • Pac-Man
    • WardriveMap
    • Random password
  • Settings
    • App Settings
    • Audio
    • Blacklist
    • Calibration
    • Touchscreen Threshold
    • Config Mode
    • Converter
    • Date/time
    • Encoder Dial
    • Freq. Correct
    • P.Mem Mgmt
    • QR code
    • Radio
    • User Interface
    • Brightness
    • Menu Color
  • Debug
    • Memory Usage
    • SD Card
    • Peripherals
    • Temperature
    • Buttons Test
    • Touch Test
    • P.Memory
    • Debug Dump
    • M0 Stack Dump
    • Fonts Viewer
    • Audio Test
  • HackRF Mode
  • USB Serial Console

Developer Manual

• 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
  • At First Glance
  • Boot Process
  • Firmware Architecture
  • Persistent Memory
  • ChibiOS Notes
• Software Dev Guides
  • Code contribution rules
  • Create a Simple App
  • Building External Apps
  • Widgets
  • SD Card
  • Access Radio Hardware
  • Interpret Guru meditation crashes
  • Create a Complex App
  • Theme-system
  • Debug via SWD & JTAG
  • Debug with serial
  • I2C drivers
• Tools
  • make_airlines_db.py
  • make_icao24_db.py
  • world_map.bin
  • converter
  • Bitmap reverse decode
• Research
  • Dissecting the Temperature Logger
  • Differences between H1 and H2
• UI Screenshots
• Maintaining
  • Creating a prod/stable release (Maintainers only)
  • Maintaining rules
• Development States Notes
  • Work Needed (Future Enhancement Suggestions)
  • External App Roadmap
  • SD card

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.