mayhem-firmware/.github/workflows/create_stable_release.yml

name: Stable Release

on:
  workflow_dispatch:

jobs:
  build:
    runs-on: ubuntu-latest
    name: build (${{ matrix.device_name }})
    strategy:
      fail-fast: false
      matrix:
        include:
          - device: default
            device_name: HackRF
            cmake_args: ""
            artifact_suffix: "_hackrf"
          - device: portarf
            device_name: PortaRF
            cmake_args: "-DFLASH_MB_SIZE=2 -DFLASH_MB_LIMIT_SIZE=2"
            artifact_suffix: "_portarf"
          - device: hpro
            device_name: HackRF Pro
            cmake_args: "-DBOARD=PRALINE"
            artifact_suffix: "_hpro"
    steps:
      - name: Get current date
        id: date
        run: echo "date=$(date +'%Y-%m-%d')" >> $GITHUB_OUTPUT
      - name: Checkout
        uses: actions/checkout@master
        with:
          fetch-depth: 0
          submodules: true
      - name: Git Sumbodule Update
        run: |
          git submodule update --init --recursive
      - name: Get version
        id: version
        run: echo "version=$(cat .github/workflows/version.txt)" >> $GITHUB_OUTPUT
      - name: Build the Docker image
        run: docker build -t portapack-dev -f dockerfile-nogit . --tag my-image-name:$(date +%s)
      - name: Make build folder
        run: mkdir ${{ github.workspace }}/build
      - name: Run the Docker image
        run: docker run -e VERSION_STRING=${{ steps.version.outputs.version }} -i -v ${{ github.workspace }}:/havoc portapack-dev ${{ matrix.cmake_args }}
      - name: Create Small SD Card ZIP - No World Map
        run: |
          mkdir -p sdcard/FIRMWARE && cp build/firmware/portapack-mayhem-firmware.bin sdcard/FIRMWARE/portapack-mayhem_${{ steps.version.outputs.version }}.bin && cp build/firmware/portapack-mayhem_OCI.ppfw.tar sdcard/FIRMWARE/mayhem_${{ steps.version.outputs.version }}${{ matrix.artifact_suffix }}_OCI.ppfw.tar && mkdir -p sdcard/APPS && cp build/firmware/application/*.ppma sdcard/APPS && cp build/firmware/standalone/*/*.ppmp sdcard/APPS && cd sdcard && zip -r ../sdcard-no-map.zip . && cd ..
      - name: Download world map
        run: |
          wget https://github.com/portapack-mayhem/mayhem-firmware/releases/download/world_map/world_map.zip
      - name: Unzip world map
        run: |
          unzip world_map.zip -d sdcard/ADSB
      - name: Prepare Firmware ZIP
        run: |
          cp build/hackrf/firmware/hackrf_usb/hackrf_usb.dfu flashing/utils/hackrf_one_usb.dfu && cp build/hackrf/firmware/hackrf_usb/hackrf_usb.bin flashing/utils/hackrf_one_usb.bin
      - name: Create Firmware ZIP
        run: |
          zip -j firmware.zip build/firmware/portapack-mayhem-firmware.bin && cd flashing && zip -r ../firmware.zip *
      - name: Create SD Card ZIP
        run: |
          mkdir -p sdcard/FIRMWARE && cp build/firmware/portapack-mayhem-firmware.bin sdcard/FIRMWARE/portapack-mayhem_${{ steps.version.outputs.version }}.bin && cp build/firmware/portapack-mayhem_OCI.ppfw.tar sdcard/FIRMWARE/mayhem_${{ steps.version.outputs.version }}${{ matrix.artifact_suffix }}_OCI.ppfw.tar && mkdir -p sdcard/APPS && cp build/firmware/application/*.ppma sdcard/APPS && cp build/firmware/standalone/*/*.ppmp sdcard/APPS && cd sdcard && zip -r ../sdcard.zip . && cd ..
      - name: Upload firmware zip artifact
        uses: actions/upload-artifact@v4
        with:
          name: firmware-${{ matrix.device }}
          path: ./firmware.zip
      - name: Upload SD card artifact
        uses: actions/upload-artifact@v4
        with:
          name: sdcard-${{ matrix.device }}
          path: ./sdcard.zip
      - name: Upload SD card no-map artifact
        uses: actions/upload-artifact@v4
        with:
          name: sdcard-no-map-${{ matrix.device }}
          path: ./sdcard-no-map.zip
      - name: Upload OCI tar artifact
        uses: actions/upload-artifact@v4
        with:
          name: oci-tar-${{ matrix.device }}
          path: build/firmware/portapack-mayhem_OCI.ppfw.tar

  release:
    needs: build
    runs-on: ubuntu-latest
    steps:
      - name: Get current date
        id: date
        run: echo "date=$(date +'%Y-%m-%d')" >> $GITHUB_OUTPUT
      - name: Checkout
        uses: actions/checkout@master
        with:
          fetch-depth: 0
          submodules: true
      - name: Get version
        id: version
        run: echo "version=$(cat .github/workflows/version.txt)" >> $GITHUB_OUTPUT
      - name: Get past version
        id: past_version
        run: echo "past_version=$(cat .github/workflows/past_version.txt)" >> $GITHUB_OUTPUT
      - name: Download all artifacts
        uses: actions/download-artifact@v4
        with:
          path: artifacts
      - name: Create changelog
        env:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: |
          {
            echo 'content<<EOF'
            python3 .github/workflows/changelog.py ${{ steps.past_version.outputs.past_version }}
            echo EOF
          } >> "$GITHUB_OUTPUT"
        id: changelog
      - name: Create Release
        id: create_release
        uses: actions/create-release@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          tag_name: ${{ steps.version.outputs.version }}
          release_name: Mayhem firmware ${{ steps.version.outputs.version }}
          body: |
            **Stable release - ${{ steps.version.outputs.version }}**
            This is a fork of the [Havoc](https://github.com/furrtek/portapack-havoc/) firmware, which itself was a fork of the [PortaPack](https://github.com/sharebrained/portapack-hackrf) firmware, an add-on for the [HackRF](http://greatscottgadgets.com/hackrf/). Please check the [readme](https://github.com/portapack-mayhem/mayhem-firmware/blob/master/README.md) for details.
            ## Release notes
            ###  Revision (${{ steps.version.outputs.version }}):
            ${{ steps.changelog.outputs.content }}

            **Full Changelog**: https://github.com/portapack-mayhem/mayhem-firmware/compare/${{ steps.past_version.outputs.past_version }}...${{ steps.version.outputs.version }}

            ## Installation
            Check the [wiki](https://github.com/portapack-mayhem/mayhem-firmware/wiki/Update-firmware) for details how to upgrade.
            __Warning:__ Since release 1.8.0, some applications has been moved to the SD card as we ran out of flash space.

            ### MicroSD card files

            For certain functionality, like external apps, the world map, GPS simulator, and others you need to uncompress (using [7-zip](https://www.7-zip.org/download.html)) the files from `mayhem_vX.Y.Z_COPY_TO_SDCARD.zip` to a FAT32 formatted MicroSD card.
          draft: true
          prerelease: false
      # Default device assets
      - name: Upload Default Firmware TAR Asset
        uses: actions/upload-release-asset@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          upload_url: ${{ steps.create_release.outputs.upload_url }}
          asset_path: artifacts/oci-tar-default/portapack-mayhem_OCI.ppfw.tar
          asset_name: OCI_hackrf_mayhem_${{ steps.version.outputs.version }}.ppfw.tar
          asset_content_type: application/x-tar
      - name: Upload Default Firmware Asset
        uses: actions/upload-release-asset@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          upload_url: ${{ steps.create_release.outputs.upload_url }}
          asset_path: artifacts/firmware-default/firmware.zip
          asset_name: FIRMWARE_hackrf_mayhem_${{ steps.version.outputs.version }}.zip
          asset_content_type: application/zip
      - name: Upload Default SD Card Asset
        uses: actions/upload-release-asset@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          upload_url: ${{ steps.create_release.outputs.upload_url }}
          asset_path: artifacts/sdcard-default/sdcard.zip
          asset_name: COPY_TO_SDCARD_hackrf_mayhem_${{ steps.version.outputs.version }}.zip
          asset_content_type: application/zip
      - name: Upload Default SD Card Asset - No Map
        uses: actions/upload-release-asset@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          upload_url: ${{ steps.create_release.outputs.upload_url }}
          asset_path: artifacts/sdcard-no-map-default/sdcard-no-map.zip
          asset_name: COPY_TO_SDCARD_hackrf_mayhem_${{ steps.version.outputs.version }}-no-world-map.zip
          asset_content_type: application/zip
      # PortaRF device assets
      - name: Upload PortaRF Firmware TAR Asset
        uses: actions/upload-release-asset@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          upload_url: ${{ steps.create_release.outputs.upload_url }}
          asset_path: artifacts/oci-tar-portarf/portapack-mayhem_OCI.ppfw.tar
          asset_name: OCI_portarf_mayhem_${{ steps.version.outputs.version }}.ppfw.tar
          asset_content_type: application/x-tar
      - name: Upload PortaRF Firmware Asset
        uses: actions/upload-release-asset@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          upload_url: ${{ steps.create_release.outputs.upload_url }}
          asset_path: artifacts/firmware-portarf/firmware.zip
          asset_name: FIRMWARE_portarf_mayhem_${{ steps.version.outputs.version }}.zip
          asset_content_type: application/zip
      - name: Upload PortaRF SD Card Asset
        uses: actions/upload-release-asset@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          upload_url: ${{ steps.create_release.outputs.upload_url }}
          asset_path: artifacts/sdcard-portarf/sdcard.zip
          asset_name: COPY_TO_SDCARD_portarf_mayhem_${{ steps.version.outputs.version }}.zip
          asset_content_type: application/zip
      - name: Upload PortaRF SD Card Asset - No Map
        uses: actions/upload-release-asset@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          upload_url: ${{ steps.create_release.outputs.upload_url }}
          asset_path: artifacts/sdcard-no-map-portarf/sdcard-no-map.zip
          asset_name: COPY_TO_SDCARD_portarf_mayhem_${{ steps.version.outputs.version }}-no-world-map.zip
          asset_content_type: application/zip
      # HPro device assets
      - name: Upload HPro Firmware TAR Asset
        uses: actions/upload-release-asset@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          upload_url: ${{ steps.create_release.outputs.upload_url }}
          asset_path: artifacts/oci-tar-hpro/portapack-mayhem_OCI.ppfw.tar
          asset_name: OCI_hpro_mayhem_${{ steps.version.outputs.version }}.ppfw.tar
          asset_content_type: application/x-tar
      - name: Upload HPro Firmware Asset
        uses: actions/upload-release-asset@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          upload_url: ${{ steps.create_release.outputs.upload_url }}
          asset_path: artifacts/firmware-hpro/firmware.zip
          asset_name: FIRMWARE_hpro_mayhem_${{ steps.version.outputs.version }}.zip
          asset_content_type: application/zip
      - name: Upload HPro SD Card Asset
        uses: actions/upload-release-asset@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          upload_url: ${{ steps.create_release.outputs.upload_url }}
          asset_path: artifacts/sdcard-hpro/sdcard.zip
          asset_name: COPY_TO_SDCARD_hpro_mayhem_${{ steps.version.outputs.version }}.zip
          asset_content_type: application/zip
      - name: Upload HPro SD Card Asset - No Map
        uses: actions/upload-release-asset@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          upload_url: ${{ steps.create_release.outputs.upload_url }}
          asset_path: artifacts/sdcard-no-map-hpro/sdcard-no-map.zip
          asset_name: COPY_TO_SDCARD_hpro_mayhem_${{ steps.version.outputs.version }}-no-world-map.zip
          asset_content_type: application/zip