Skip to content

Commit

Permalink
Merge pull request #741 from marionbarker/working-docs
Browse files Browse the repository at this point in the history
Add more emphasis on signing developer agreement
  • Loading branch information
marionbarker authored Oct 9, 2023
2 parents 365619b + e56e503 commit b93b538
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 6 deletions.
25 changes: 20 additions & 5 deletions docs/gh-actions/gh-errors.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,37 +2,52 @@

If you get an error when building with a browser, use this page to figure out what to do.

If you are still unsuccessful, then post your request for help along with your *GitHub* **username**. Mentors can go to your public&nbsp;<span translate="no">GitHub repository</span>, check the status and then view your log files directly.
If you are still unsuccessful, then post your request for help along with your *GitHub* **username**. Mentors can go to your public&nbsp;_<span translate="no">GitHub repository</span>_, check the status and then view your log files directly.

* Do not copy from the log file and post the words
* Do not take a screenshot of what you think is an error
* Just post your username and the name of the app you are trying to build

!!! tip "Username, Not Pictures"
If you've been around the DIY community for a while, you know the mantra about screenshots. Well, when using a browser to build, **screenshots are close to useless**.
If you've been around the DIY community for a while, you know the mantra about screenshots. Well, when using a browser to build, **screenshots are close to useless**.

All that is needed to assist is your *GitHub* **username**.

But first - try to diagnose it yourself using this page.

### Most Common Mistakes

These are some of the most common errors to date.

* Common mistake: you made a spelling error when adding Secrets
* Common mistake: you made a spelling error when adding <code>Secrets</code>
* Each secret must be spelled exactly the way it is presented in the instructions
* If you are using an automatic translation, please keep an original page open too and copy from it to make sure there are no spelling errors in the secret name
* Common mistake: use a smart editor instead of a text-only editor to save your information
* It only takes one letter to be changed from lower-case to upper-case by your smart editor to ruin your day
* The alpha-numeric values used for `GH_PAT`, `FASTLANE_ISSUER_ID` and `FASTLANE_KEY` contain both upper and lower-case characters and all the values are case-sensitive
* Common mistake: when saving `TEAMID`, you type what you think you see instead of using copy and paste
* Common mistake: skip running one of the actions
* Common mistake: you need to sign a program license agreement at&nbsp;<span translate="no">Apple Developer</span>
* Common mistake: you need to sign a program license agreement at&nbsp;<span translate="no">Apple Developer</span> - be sure to read [Misleading Error Message](#misleading-error-message)

If you are running development code, skip ahead to [Preview for Version 3.4](#preview-for-version-34).

The next section is valid for Version 3.2.x and earlier.
## Misleading Error Message

> For Version 3.2.x and earlier - later versions give better error messages.
If there are *Apple* Developer agreements you have not accepted, you will get errors when you try to Build that indicate your *Apple* <code>Secrets</code> are incorrect even if they are not.

* The misleading message tells you that one or more of these: <code>FASTLANE_ISSUER_ID</code>, <code>FASTLANE_KEY_ID</code> or <code>FASTLANE_KEY</code> is not correct
* Check your *Apple* Developer account for agreements first, before trying to fix those
* If you previously built successfully - it is almost certainly the agreement
* It can take 15 minutes to an hour after the agreement is signed before it can be used

If you need detailed instructions, click on this [<code>Apple Program License Agreement</code> Help Page](https://support.pushpay.com/s/article/Accepting-the-Apple-Program-License-Agreement).

## Find Your Error

> For Version 3.2.x and earlier - later versions have an improved method for display errors.
There is a separate section for each step in the process. First, you must follow the [Examine the Error](#examine-the-error) instructions to view the record of the failed action. Then go to the section for the Action you were trying to complete to look for possible error strings to copy into the search box.

1. [Action: `Validate Secrets`](#action-validate-secrets-errors)
Expand Down
4 changes: 4 additions & 0 deletions docs/gh-actions/gh-first-time.md
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,8 @@ You need to save your information digitally, so you can copy and paste. The info
You will be saving 4 <code>Secrets</code> from your *Apple* Account in this step.

1. Sign in to the [*Apple* developer portal page](https://developer.apple.com/account/resources/certificates/list).
1. If you need to accept a new agreement (happens about twice a year), be sure to do so now
* Need help? Look at this section on the update page: [Accept Agreements](gh-update.md#accept-agreements)
1. Copy the Team ID from the upper right of the screen. [Record this as your `TEAMID`](#find-teamid).
1. Go to the [App Store Connect](https://appstoreconnect.apple.com/access/api) interface, click the "Keys" tab, and create a new key with "Admin" access. Give it the name: ["`FastLane API Key`"](#generate-api-key).
1. [Record three more secrets](#copy-api-key-secrets)
Expand Down Expand Up @@ -232,6 +234,8 @@ If not, you need to purchase one ($99 annual fee). It may take a few days for th
Sign in to your *Apple* Developer account at this link: [*Apple* developer portal page](https://developer.apple.com/account).

1. Click `Account` in the top menu bar
1. If you need to accept a new agreement (happens about twice a year), be sure to do so now
* Need help? Look at this section on the update page: [Accept Agreements](gh-update.md#accept-agreements)
1. Click the `Membership Details` icon

![Apple Developer Account Membership Details](img/apple_dev_account-teamid-001.svg){width="600"}
Expand Down
6 changes: 5 additions & 1 deletion docs/gh-actions/gh-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,12 +53,16 @@ Sign in to your [Apple Developer account](https://developer.apple.com/account).
* For an update, you do not need to modify the <code>FASTLANE_ISSUER_ID</code>, <code>FASTLANE_KEY_ID</code> or <code>FASTLANE_KEY</code>
* Check your *Apple* Developer account for agreements, then continue

If you need detailed instructions, click on the [<code>Apple Program License Agreement</code>](https://support.pushpay.com/s/article/Accepting-the-Apple-Program-License-Agreement) help page.
If you need detailed instructions, click on this [<code>Apple Program License Agreement</code> Help Page](https://support.pushpay.com/s/article/Accepting-the-Apple-Program-License-Agreement).

* Accept the `Apple Program License Agreement` (only)
* You do NOT need to accept anything related to the `Paid Applications Schedule Agreement`
* That is only required when you sell an app through the `App Store`

!!! warning "Wait After You Agree"
It typically takes 15 minutes before your updated agreement is available so you can complete your build.

If your build with browser fails, wait longer. An hour wait was reported by one person.

### Update Fork

Expand Down

0 comments on commit b93b538

Please sign in to comment.