action-electron-builder

The action automatically creates a GitHub Release draft when it detects a version tag. To trigger a release:

1. Update the version in package.json (e.g., 1.2.3).
2. Commit the change: git commit -am v1.2.3.
3. Tag the commit using the v*.*.* format: git tag v1.2.3.
4. Push both changes and tags: git push && git push --tags.

The release option in the workflow configuration (e.g., release: ${{ startsWith(github.ref, 'refs/tags/v') }}) determines if the app should be released after building.

To sign your macOS app, you must provide your certificates via GitHub Secrets:

1. Export your certificates into a single .p12 file with a password.
2. Base64-encode the file: base64 -i certs.p12 -o encoded.txt.
3. Add mac_certs (the content of encoded.txt) and mac_certs_password to your GitHub repository secrets.
4. Pass them to the action in your workflow.

- name: Build/release Electron app
  uses: samuelmeuli/action-electron-builder@v1
  with:
    # ...
    mac_certs: ${{ secrets.mac_certs }}
    mac_certs_password: ${{ secrets.mac_certs_password }}

If you are building for Snapcraft, use the action-snapcraft action before the action-electron-builder step to install and sign in.

- name: Install Snapcraft
  uses: samuelmeuli/action-snapcraft@v1
  if: startsWith(matrix.os, 'ubuntu')
  with:
    snapcraft_token: ${{ secrets.snapcraft_token }}

If you use electron-builder for notarization, you can automate the process in GitHub Actions:

1. Set Secrets: Add api_key (the .p8 file content), api_key_id, and api_key_issuer_id to your GitHub repository secrets.
2. Prepare Key: Add a step before the build step to write the API key to the expected path.
3. Pass Environment Variables: Provide the ID and Issuer ID to the action via env.

- name: Prepare for app notarization
  if: startsWith(matrix.os, 'macos')
  run: |
    mkdir -p ~/private_keys/
    echo '${{ secrets.api_key }}' > ~/private_keys/AuthKey_${{ secrets.api_key_id }}.p8

- name: Build/release Electron app
  uses: samuelmeuli/action-electron-builder@v1
  with:
    # ...
  env:
    API_KEY_ID: ${{ secrets.api_key_id }}
    API_KEY_ISSUER_ID: ${{ secrets.api_key_issuer_id }}

You can customize the behavior of the action-electron-builder using the following input parameters:

The action automatically detects whether to use npm or yarn based on the presence of a lockfile in the package_root:

• If package-lock.json exists, the action uses NPM.
• If package-lock.json is absent, the action uses Yarn.

This detection affects the dependency installation step (npm install vs yarn) and the execution of the build command.

To sign your Electron application during the build process, you must provide certificate information via the following inputs. The action automatically exports these to the environment variables required by electron-builder (CSC_LINK and CSC_KEY_PASSWORD).