Skip to content
This repository was archived by the owner on Oct 31, 2023. It is now read-only.

Commit d4cbc0c

Browse files
committed
update README
1 parent b45a4b8 commit d4cbc0c

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ gon helps you automate the process of notarization.
2626
- [Usage](#usage)
2727
- [Prerequisite: Acquiring a Developer ID Certificate](#prerequisite-acquiring-a-developer-id-certificate)
2828
- [Configuration File](#configuration-file)
29+
- [Notarization-Only Configuration](#notarization-only-configuration)
2930
- [Processing Time](#processing-time)
3031
- [Using within Automation](#using-within-automation)
3132
- [Machine-Readable Output](#machine-readable-output)
@@ -253,6 +254,12 @@ You can configure `gon` to notarize already-signed files. This is useful
253254
if you're integrating `gon` into an existing build pipeline that may already
254255
support creation of pkg, app, etc. files.
255256

257+
Because notarization requires the payload of packages to also be signed, this
258+
mode assumes that you have codesigned the payload as well as the package
259+
itself. `gon` _will not_ sign your package in the `notarize` blocks.
260+
Please do not confuse this with when `source` is set and `gon` itself
261+
_creates_ your packages, in which case it will also sign them.
262+
256263
You can use this in addition to specifying `source` as well. In this case,
257264
we will codesign & package the files specified in `source` and then notarize
258265
those results as well as those in `notarize` blocks.
@@ -282,13 +289,13 @@ apple_id {
282289

283290
"notarize": [{
284291
"path": "/path/to/terraform.pkg",
285-
"bundle_id": "com.mitchellh.example.terraform",
286-
"staple": true
292+
"bundle_id": "com.mitchellh.example.terraform",
293+
"staple": true
287294
}],
288295

289296
"apple_id": {
290297
"username": "mitchell@example.com",
291-
"password": "@env:AC_PASSWORD"
298+
"password": "@env:AC_PASSWORD"
292299
}
293300
}
294301
```

0 commit comments

Comments
 (0)