Notary Tools

June 14, 2023 ยท View on GitHub

notarize

โ˜ž Github Action to notarize and staple macOS applications or packages.

It does this by:

  • storing credentials on keychain (by using xcrun notarytool store-credentials)
  • submitting a built .app, .pkg or .dmg file to Apple's notary service (by using xcrun notarytool submit)
  • stapling the product (by using xcrun stapler).

Reference

๐Ÿ“š Usage

Simple value

runs-on: macos-latest
steps:
  uses: GuillaumeFalourd/notary-tools@v1
  with:
    product_path: "path/to/file.app" # or .pkg or .dmg
    apple_id: ${{ secrets.APPLE_ID }}
    password: ${{ secrets.PASSWORD }}
    team_id: ${{ secrets.TEAM_ID }}
    # Not mandatory inputs
    staple: 'false'
    keychain_profile: 'my-keychain-profile'
    xcode_path: '/Applications/Xcode_13.3.app'

โ–ถ๏ธ Action Inputs

FieldMandatoryObservation
product_pathYESPath to the product to notarize.
e.g: path/to/product
apple_idYESnotarytool --apple-id parameter
passwordYESnotarytool --password parameter
team_idYESnotarytool --team-id parameter.
keychain_profileNOnotarytool --keychain-profile parameter
Default notarization
stapleNOWhether to staple the notarized product
Default true
xcode_pathNOPath of the Xcode version to use
Default /Applications/Xcode_13.2.1.app

๐Ÿค Contributing

โ˜ž If you're interested in contributing to this repository, please follow the guidelines

๐Ÿ… Licensed

โ˜ž This repository uses the Apache License 2.0