Merge pull request #290 from freakboy3742/macos-signing

Refs #174 - Adds code signing for macOS apps

Author: freakboy3742

docs/how-to/code-signing/index.rst

@@ -0,0 +1,17 @@
+=================================
+Obtaining a Code Signing identity
+=================================
+
+If you are intending to distribute an application, it is advisable (and, on
+some platforms, necessary) to code sign your application. This is a
+cryptographic process that identifies you as a developer, and identifies your
+application as something that has been distributed by you.
+
+The process of obtaining a code signing identity is slightly different on
+every platform. The following are guides for every platform that Briefcase
+supports:
+
+.. toctree::
+   :maxdepth: 1
+
+   macOS

docs/how-to/code-signing/macOS.rst

@@ -0,0 +1,5 @@
+=====
+macOS
+=====
+
+**TODO**

docs/how-to/index.rst

@@ -15,5 +15,6 @@ stand alone.
 
    contribute-code
    contribute-docs
+   code-signing/index
    See errors on iOS <see_errors_on_ios>
    internal/index

docs/reference/commands/build.rst

@@ -2,8 +2,11 @@
 build
 =====
 
-Compile/build an application installer. By default, targets the current
-platform's default output format.
+Compile/build an application. By default, targets the current platform's
+default output format.
+
+This will only compile the components necessary to *run* the application. It
+won't necessarily result in the generation of an installable artefact.
 
 Usage
 =====
@@ -40,4 +43,4 @@ The following options can be provided at the command line.
 Update the application's source code before running. Equivalent to running::
 
     $ briefcase update
-    $ briefcase run
+    $ briefcase build

docs/reference/commands/index.rst

@@ -11,4 +11,5 @@ Command reference
    update
    build
    run
+   package
    publish

docs/reference/commands/package.rst

@@ -0,0 +1,45 @@
+=======
+package
+=======
+
+Compile/build an application installer. By default, targets the current
+platform's default output format.
+
+This will produce an installable artefact.
+
+Usage
+=====
+
+To build an installer of the default output format for the current platform::
+
+    $ briefcase package
+
+To build an installer for a different platform::
+
+    $ briefcase package <platform>
+
+To build an installer for a specific output format::
+
+    $ briefcase package <platform> <output format>
+
+.. admonition:: Packaging tool dependencies
+
+    Building installers for some platforms depends on the build tools for the
+    platform you're targetting being available on the platform you're using.
+    For example, you will only be able to create iOS applications on macOS.
+    Briefcase will check for any required tools, and will report an error if
+    the platform you're targetting is not supported.
+
+Options
+=======
+
+The following options can be provided at the command line.
+
+``-u`` / ``--update``
+---------------------
+
+Update and recompile the application's code before running. Equivalent to
+running::
+
+    $ briefcase update
+    $ briefcase package

docs/reference/platforms/iOS.rst

@@ -50,4 +50,25 @@ provide splash images of the following sizes:
   * 2436x1125px
   * 2688x1242px
 
-iOS Projects do not support installer images.
+iOS projects do not support installer images.
+
+Additional options
+==================
+
+The following options can be provided at the command line when producing
+iOS projects
+
+build
+-----
+
+``-d <device>`` / ``--device <device>``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The device simulator to target. Can be either a UDID, a device name (e.g.,
+``"iPhone 11"``), or a device name and OS version (``"iPhone 11::13.3"``).
+
+run
+---
+
+The device simulator to target. Can be either a UDID, a device name (e.g.,
+``"iPhone 11"``), or a device name and OS version (``"iPhone 11::13.3"``).

docs/reference/platforms/macOS/app.rst

@@ -18,3 +18,22 @@ Image format
 ============
 
 ``.app`` bundles do not support splash screens or installer images.
+
+Additional options
+==================
+
+The following options can be provided at the command line when producing
+``.app`` bundles.
+
+publish
+-------
+
+``--no-sign``
+~~~~~~~~~~~~~
+
+Don't perform code signing on the ``.app`` bundles.
+
+``-i <identity>`` / ``--identity <identity>``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The code signing identity to use when signing the ``.app`` bundles.

docs/reference/platforms/macOS/dmg.rst

@@ -25,3 +25,22 @@ Image format
 
 macOS DMGs do not support splash screens. The installer background must be
 in ``.png`` format.
+
+Additional options
+==================
+
+The following options can be provided at the command line when producing
+DMGs.
+
+publish
+-------
+
+``--no-sign``
+~~~~~~~~~~~~~
+
+Don't perform code signing on the ``.app`` bundles in the DMG.
+
+``-i <identity>`` / ``--identity <identity>``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The code signing identity to use when signing the ``.app`` bundles in the DMG.

src/briefcase/cmdline.py

@@ -42,7 +42,9 @@ def parse_cmdline(args):
     # usage string so that the instructions displayed are correct
     parser.add_argument(
         'command',
-        choices=['new', 'dev', 'create', 'update', 'build', 'run', 'publish'],
+        choices=[
+            'new', 'dev', 'create', 'update', 'build', 'run', 'package', 'publish'
+        ],
         metavar='command',
         nargs='?',
         help='the command to execute (one of: %(choices)s)',