insomnia/.github/workflows/release-build.yml

name: Release Build

on:
  push:
    branches:
      - 'release/**'
  workflow_dispatch:

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

jobs:
  # shared kong github action for security checking
  generate-sbom-and-upload-assets:
    runs-on: ubuntu-22.04
    permissions:
      packages: write
      contents: write # publish sbom to GH releases/tag assets
    steps:
      - name: Checkout repository
        uses: actions/checkout@v3

      # Perform SCA / SBOM analysis for the entire monorepo code repository
      # Produces SCA(SBOM and CVE) report
      # Helps understand vulnerabilities / license compliance across third party dependencies
      # Automatically uploads to workflow assets
      # (TODO): Produce workspace/package specific SBOM. Current limitation: https://github.com/anchore/syft/issues/2574
      # (TODO): needs check (block) further steps if SCA fails
      - id: sca-project
        uses: Kong/public-shared-actions/security-actions/sca@a18abf762d6e2444bcbfd20de70451ea1e3bc1b1 # v4.1.1
        with:
          dir: .
          upload-sbom-release-assets: false
  build-and-upload-release-artifacts:
    timeout-minutes: 45
    runs-on: ${{ matrix.os }}
    env:
      INSO_PACKAGE_NAME: insomnia-inso
      INSO_DOCKER_TAR: inso-docker-image.tar
    strategy:
      fail-fast: false
      matrix:
        include:
          - os: macos-latest-large
            csc_link_secret: DESIGNER_MAC_CSC_LINK
            csc_key_password_secret: DESIGNER_MAC_CSC_KEY_PASSWORD
          - os: windows-latest
            csc_link_secret: ''
            csc_key_password_secret: ''
          - os: ubuntu-22.04
            csc_link_secret: ''
            csc_key_password_secret: ''
          # - os: ubuntu-22.04-arm
          #   csc_link_secret: ''
          #   csc_key_password_secret: ''
    steps:
      - name: Checkout branch
        uses: actions/checkout@v4

      - name: Setup Node
        uses: actions/setup-node@v4
        with:
          node-version-file: '.nvmrc'
          cache: 'npm'
          cache-dependency-path: package-lock.json
          registry-url: 'https://npm.pkg.github.com'
          scope: '@kong'

      - name: Install packages
        run: npm ci
        env:
          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

      - name: Setup Inso CLI version env var
        shell: bash
        run: |
          echo "INSO_VERSION=$(jq .version ./packages/${{ env.INSO_PACKAGE_NAME }}/package.json -rj)" >> $GITHUB_ENV

      - name: Package app (Linux ARM64 only)
        if: runner.os == 'Linux' && runner.arch == 'ARM64'
        shell: bash
        run: npm run app-package
        env:
          NODE_OPTIONS: '--max_old_space_size=6144'
          BUILD_TARGETS: AppImage,tar.gz

      - name: Package app (Linux X64 only)
        if: runner.os == 'Linux' && runner.arch == 'X64'
        shell: bash
        run: npm run app-package
        env:
          NODE_OPTIONS: '--max_old_space_size=6144'

      # If this step fails its possible apple has new license terms which need to be accepted by logging into https://developer.apple.com/account
      - name: Package app (MacOS only)
        if: runner.os == 'macOS'
        shell: bash
        run: npm run app-package
        env:
          NODE_OPTIONS: '--max_old_space_size=6144'
          APPLE_ID: ${{ runner.os == 'macOS' && secrets.DESIGNER_APPLE_ID || '' }}
          APPLE_APP_SPECIFIC_PASSWORD: ${{ runner.os == 'macOS' && secrets.DESIGNER_APPLE_ID_PASSWORD || '' }}
          APPLE_TEAM_ID: FX44YY62GV
          CSC_LINK: ${{ matrix.csc_link_secret != '' && secrets[matrix.csc_link_secret] || '' }}
          CSC_KEY_PASSWORD: ${{ matrix.csc_key_password_secret != '' && secrets[matrix.csc_key_password_secret] || ''  }}

      # creates unpacked electron-builder contents that can be signed afterwards
      - name: Package unpacked app (Windows only)
        if: runner.os == 'Windows'
        shell: bash
        run: NODE_OPTIONS='--max_old_space_size=6144' npm run package:windows:unpacked -w insomnia

      # wraps the Insomnia.exe PE with another PE that will bootstrap particular security
      # features added to Windows 8 in order to stopgap CVE-2025-1353
      - name: Compile secure wrapper (Windows only)
        if: runner.os == 'Windows'
        shell: bash
        run: ./build-secure-wrapper.sh CI

      - name: Move .dll and .exe files to /tosign (PowerShell)
        if: runner.os == 'Windows'
        shell: pwsh
        run: |
          New-Item -Path "packages/insomnia/dist/win-unpacked/tosign" -ItemType Directory -Force
          New-Item -Path "packages/insomnia/dist/win-unpacked/signed" -ItemType Directory -Force
          Get-ChildItem -Path "packages/insomnia/dist/win-unpacked" -Filter *.dll | Move-Item -Destination "packages/insomnia/dist/win-unpacked/tosign"
          Get-ChildItem -Path "packages/insomnia/dist/win-unpacked" -Filter *.exe | Move-Item -Destination "packages/insomnia/dist/win-unpacked/tosign"

      # signs unpacked electron-builder contents, in this case only the .exe
      - name: Code-sign unpacked .exe (Windows only)
        if: runner.os == 'Windows'
        uses: sslcom/esigner-codesign@3b2dc3b6075c05ef889d88b761a1fd0183b28c6a # develop
        with:
          command: batch_sign
          username: ${{secrets.ES_USERNAME}}
          password: ${{secrets.ES_PASSWORD}}
          credential_id: ${{secrets.ES_CREDENTIAL_ID}}
          totp_secret: ${{secrets.ES_TOTP_SECRET}}
          dir_path: packages/insomnia/dist/win-unpacked/tosign
          output_path: packages/insomnia/dist/win-unpacked/signed
          override: true

      - name: Move .dll and .exe files back to win-unpacked and delete /tosign
        if: runner.os == 'Windows'
        shell: pwsh
        run: |
          Get-ChildItem -Path "packages/insomnia/dist/win-unpacked/signed" -Filter *.dll | Move-Item -Destination "packages/insomnia/dist/win-unpacked"
          Get-ChildItem -Path "packages/insomnia/dist/win-unpacked/signed" -Filter *.exe | Move-Item -Destination "packages/insomnia/dist/win-unpacked"
          Remove-Item -Path "packages/insomnia/dist/win-unpacked/tosign" -Recurse -Force
          Remove-Item -Path "packages/insomnia/dist/win-unpacked/signed" -Recurse -Force

      # re-packages the now code-signed electron-builder contents into the installer
      - name: Package dist app (Windows only)
        if: runner.os == 'Windows'
        shell: bash
        run: |
          docker pull ghcr.io/sslcom/codesigner-win:latest
          NODE_OPTIONS='--max_old_space_size=6144' npm run package:windows:dist -w insomnia
        env:
          USERNAME: ${{secrets.ES_USERNAME}}
          PASSWORD: ${{secrets.ES_PASSWORD}}
          CREDENTIAL_ID: ${{secrets.ES_CREDENTIAL_ID}}
          TOTP_SECRET: ${{secrets.ES_TOTP_SECRET}}

      - name: Package inso
        run: |
          echo "Replacing electron binary with node binary"
          node_modules/.bin/node-pre-gyp install --update-binary --directory node_modules/@getinsomnia/node-libcurl
          npm run build:production -w insomnia-inso
          npm run package -w insomnia-inso
        env:
          VERSION: ${{ env.INSO_VERSION }}

      - name: Code-sign inso exe (Windows only)
        if: runner.os == 'Windows'
        uses: sslcom/esigner-codesign@3b2dc3b6075c05ef889d88b761a1fd0183b28c6a # develop
        with:
          command: sign
          username: ${{secrets.ES_USERNAME}}
          password: ${{secrets.ES_PASSWORD}}
          credential_id: ${{secrets.ES_CREDENTIAL_ID}}
          totp_secret: ${{secrets.ES_TOTP_SECRET}}
          file_path: packages/insomnia-inso/binaries/inso.exe
          override: true

      - name: Code-sign & create Inso CLI installer (macOS only)
        if: runner.os == 'macOS'
        run: ./src/scripts/macos-pkg.sh
        shell: bash
        working-directory: ./packages/${{ env.INSO_PACKAGE_NAME }}
        continue-on-error: false
        env:
          MACOS_CERTIFICATE: ${{ secrets.DESIGNER_MAC_CSC_LINK }}
          MACOS_CERTIFICATE_PWD: ${{ secrets.DESIGNER_MAC_CSC_KEY_PASSWORD }}
          PKG_NAME: inso-${{ matrix.os }}-${{ env.INSO_VERSION }}
          BUNDLE_ID: com.insomnia.inso
          VERSION: ${{ env.INSO_VERSION }}

      - name: Notarize Inso CLI installer (macOS only)
        if: runner.os == 'macOS'
        uses: lando/notarize-action@b5c3ef16cf2fbcf2af26dc58c90255ec242abeed # v2
        with:
          product-path: ./packages/${{ env.INSO_PACKAGE_NAME }}/artifacts/inso-${{ matrix.os }}-${{ env.INSO_VERSION }}.pkg
          primary-bundle-id: com.insomnia.inso
          appstore-connect-username: ${{ secrets.DESIGNER_APPLE_ID }}
          appstore-connect-password: ${{ secrets.DESIGNER_APPLE_ID_PASSWORD }}
          appstore-connect-team-id: FX44YY62GV
          verbose: true

      - name: Staple Inso CLI installer (macOS only)
        if: runner.os == 'macOS'
        uses: BoundfoxStudios/action-xcode-staple@1e2200b448c6ed4dd44b963ff17d3e340fc6b064 # v1
        with:
          product-path: ./packages/${{ env.INSO_PACKAGE_NAME }}/artifacts/inso-${{ matrix.os }}-${{ env.INSO_VERSION }}.pkg

      - name: Notarize Inso CLI binary (macOS only)
        if: runner.os == 'macOS'
        uses: lando/notarize-action@b5c3ef16cf2fbcf2af26dc58c90255ec242abeed # v2
        with:
          product-path: ./packages/${{ env.INSO_PACKAGE_NAME }}/binaries/inso
          primary-bundle-id: com.insomnia.inso-binary
          appstore-connect-username: ${{ secrets.DESIGNER_APPLE_ID }}
          appstore-connect-password: ${{ secrets.DESIGNER_APPLE_ID_PASSWORD }}
          appstore-connect-team-id: FX44YY62GV

      - name: Create Inso zip/tar/gz artifacts
        run: npm run artifacts -w insomnia-inso

      - name: Login to Docker Hub
        if: runner.os == 'Linux' && runner.arch == 'X64'
        uses: docker/login-action@3d58c274f17dffee475a5520cbe67f0a882c4dbb # v2.1.0
        with:
          username: ${{ secrets.DOCKER_REGISTRY_USER }}
          password: ${{ secrets.DOCKER_REGISTRY_TOKEN }}

      - name: Create inso Docker Image artifacts
        if: runner.os == 'Linux' && runner.arch == 'X64'
        run: |
          DOCKER_BUILDKIT=1 docker build --tag ${{ env.INSO_PACKAGE_NAME }}:temp ./packages/${{ env.INSO_PACKAGE_NAME }}
          docker save ${{ env.INSO_PACKAGE_NAME }}:temp -o ./packages/${{ env.INSO_PACKAGE_NAME }}/artifacts/${{ env.INSO_DOCKER_TAR }}

      # Produce Docker SBOM for Inso Image
      # Automatically uploads to workflow assets
      - name: Scan inso docker artifacts
        id: sbom_action
        if: runner.os == 'Linux' && runner.arch == 'X64'
        uses: Kong/public-shared-actions/security-actions/scan-docker-image@a18abf762d6e2444bcbfd20de70451ea1e3bc1b1 # v4.1.1
        with:
          asset_prefix: image-inso-${{ runner.os }}-${{ runner.arch }}
          image: ./packages/${{ env.INSO_PACKAGE_NAME }}/artifacts/${{ env.INSO_DOCKER_TAR }}
          upload-sbom-release-assets: false # No release is publushed yet. Uploads as workflow assets
          skip_cis_scan: true
        env:
          SYFT_SOURCE_NAME: ${{ env.INSO_DOCKER_TAR }}

      - name: Upload artifacts
        uses: actions/upload-artifact@v4
        with:
          if-no-files-found: ignore
          name: ${{ runner.os }}-${{ runner.arch }}-artifacts
          path: |
            packages/insomnia/dist/*.exe
            packages/insomnia/dist/*.yml
            packages/insomnia/dist/squirrel-windows/*
            packages/insomnia/dist/*.zip
            packages/insomnia/dist/*.dmg
            packages/insomnia/dist/*.snap
            packages/insomnia/dist/*.rpm
            packages/insomnia/dist/*.deb
            packages/insomnia/dist/*.AppImage
            packages/insomnia/dist/*.tar.gz
            packages/insomnia-inso/artifacts/*

      - name: Upload source assets for Sentry
        uses: actions/upload-artifact@v4
        with:
          name: ${{ runner.os }}-${{ runner.arch }}-sentry
          path: |
            packages/insomnia/build/*.js
            packages/insomnia/build/*.map
            packages/insomnia/build/client/assets/*.js
            packages/insomnia/build/client/assets/*.map
            !packages/insomnia/build/yarn-standalone.js

  update-pull-request:
    timeout-minutes: ${{ fromJSON(vars.GHA_DEFAULT_TIMEOUT) }}
    needs: build-and-upload-release-artifacts
    runs-on: ubuntu-22.04
    steps:
      - name: Get release version
        id: release_version
        shell: bash
        run: |
          echo "version=${BRANCH/release\//}" >> $GITHUB_OUTPUT
        env:
          BRANCH: ${{ github.ref_name }}

      - name: update-pull-request
        uses: kt3k/update-pr-description@fef8b17c6648e0daa550d2ed6b5cf140d282574e # v2.0.0
        with:
          pr_body: |
            # WARNING: <ins>Do not merge</ins> this PR. Use the "Publish" workflow.

            ## Publish workflow:

            When ready to publish, trigger [Publish](https://github.com/${{ github.repository }}/actions/workflows/release-publish.yml) workflow with these variables:
            - Release version (`version`): `${{ steps.release_version.outputs.version }}`

            Alternatively, you can trigger the workflow from [GitHub CLI](https://cli.github.com/):
            ```bash
            gh workflow run release-publish.yml -f version=${{ steps.release_version.outputs.version }} --repo ${{ github.repository }}
            ```

            > Release notes will be generated automatically based on the commit messages during publish. Remove any unwanted notes manually afterwards.

            ## Release artifacts:

            Download release artifacts [here](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }})

            <details>
            <summary>Edit Changelog file...</summary>

            You can update the changelog.md in this branch, run git log to get the latest changes:

            ```bash
            git log --no-merges --oneline --pretty=format:'* %s by @%an' --since="<last release tag>" --until="release/${{ steps.release_version.outputs.version }}"
            ```
            </details>

            <details>
            <summary>Conflicts? Merge branch step failed on the publish workflow? Try this...</summary>

            Run locally:

            ```bash
            # Make sure git remote is Kong/insomnia...

            git checkout develop
            git merge --no-ff release/<replaced with version>

            # Solve merge conflicts ...
            # If there's package-lock conflicts, run `npm install` and commit the package-lock changes

            git push
            ```
            </details>
          destination_branch: develop
          github_token: ${{ secrets.GITHUB_TOKEN }}