Report an issue

When something goes wrong, Help › Report an Issue sends a report with what you write and the details needed to look into it. You see everything before it goes, and you choose what to include.

Send a report

1. Choose Help › Report an Issue. If an error’s details have a Report button, choosing it starts the report with that error’s code and title filled in.
2. Write a short summary, and what happened in the details: what you did, what you expected and what happened instead.
3. Check what’s included. Choose Show on any row to see exactly what will be sent.
4. Choose Send report, and approve the request or touch your security key if you’re asked.

Revue says “Report sent” with a reference such as R-42. Keep it if you might write about the report later.

You need to be signed in to GitHub in Revue, because the report is sent under your GitHub username. See Sign in to GitHub.

What’s included

Every item is ticked to begin with. Untick any you’d rather not send.

• Revue and this Mac: the versions of Revue and macOS, and your Mac’s model, chip and memory.
• Diagnostics: the report Help › Copy Diagnostics makes.
• Recent errors: the error codes Revue showed in the last 24 hours.
• Recent crashes: crash reports from the last 7 days.
• Recent log: the last 200 lines of Revue’s log.
• Settings: the settings that change how Revue behaves.
• Current view: which screen and mode you were in, and how many files and comments it showed, without their names.
• Link to usage statistics: this Mac’s install ID, which links the report to the usage statistics this Mac has sent, so Ryan can see what led up to the problem.

Paths show your home folder as ~, and tokens, email addresses and the names of your repositories and branches are taken out of the items. What you write in the summary and details is sent as you wrote it, so leave out anything private. If the summary or details look like they hold a token, Revue says so and won’t send until you remove it.

Copy report puts the same report on the clipboard instead, so you can send it another way.

How Revue signs a report

Revue shows a report is from you by signing it with an SSH key that’s on your GitHub account. Revue’s server checks the signature against the public keys GitHub lists for your account, so nobody can send a report under your name without your key. No GitHub sign-in or token is sent.

The sheet shows which key will sign under your username. When more than one of your keys would work, you can choose another. Revue looks for keys in this order:

1. The key git signs commits with, if you sign with SSH.
2. Keys in an SSH agent, including the macOS keychain, 1Password and Secretive.
3. Key files in ~/.ssh.

Revue never reads a private key itself. Your SSH agent or ssh-keygen does the signing:

• 1Password or Secretive asks you to approve the request.
• A security key asks for a touch.
• A key file with a passphrase asks for the passphrase in the sheet. Revue hands it to ssh-keygen once and doesn’t keep it.

Add an SSH key to GitHub

If no key on this Mac is on your GitHub account, Revue can’t sign the report and says “Add an SSH key to GitHub”. To make a new key and add it:

1. In Terminal, run ssh-keygen -t ed25519 and press Return to accept the suggested file.
2. Copy the public key with pbcopy < ~/.ssh/id_ed25519.pub.
3. On GitHub, open Settings › SSH and GPG keys and click New SSH key. Either key type, authentication or signing, works. Paste the key and click Add SSH key.
4. Come back to Revue and choose Check again.

If you already have a key in an SSH agent, such as 1Password, copy its public half with ssh-add -L instead, and add that line to GitHub. A key you just added can take a few minutes to count.

Revue doesn’t use certificates, DSA keys, ECDSA keys on the P-521 curve, or RSA keys shorter than 2048 bits.

When a report can’t be sent

Your report is saved when sending fails, and Revue offers it again the next time it opens.

Revue says	What to do
Couldn’t reach Revue’s server	Check your connection, then choose Try again.
Revue’s server didn’t accept the signature	Try again, or choose another key.
GitHub doesn’t list this key	If you just added the key, wait a few minutes and try again, or choose another key.
GitHub doesn’t show you as the account Revue is signed in to	Sign in to GitHub again in Revue, then send.
Your Mac’s clock is off by more than 10 minutes	Turn on setting the date and time automatically in System Settings, then try again.
You’ve sent several reports recently	Try again in a little while. Your report is kept.
Your GitHub account is too new	Copy the report and send it another way.
Revue can’t send reports right now	Copy the report and send it another way.
The report wasn’t signed	Your SSH agent turned the request down or it was cancelled. Try again, or choose another key.
Signing took too long	Nothing answered the request to sign. Try again, or choose another key.
That passphrase didn’t work	Type the key’s passphrase again.
This Mac’s ssh-keygen can’t use this security key	Add the key to an SSH agent, or choose another key.
Your SSH agent signed with an old algorithm	Choose another key, or update the agent.

Delete your reports

Reports are kept until Ryan deletes them. To have yours deleted, email [email protected] with a report’s reference, such as R-42, or your GitHub username for all of them.

So that nobody can get someone else’s reports deleted, Ryan replies with a short random message in a file, challenge.txt. Sign exactly that file with the SSH key the report was signed with, or any SSH key now on your GitHub account, and send back the challenge.txt.sig it makes: ssh-keygen -Y sign -n [email protected] -f ~/.ssh/id_ed25519 challenge.txt

Use your own key’s file in place of ~/.ssh/id_ed25519. If your key is only in an SSH agent, such as 1Password, ask Ryan for the command to use with it. A signature made for anything else, such as a signed git commit, isn’t accepted. Privacy says what’s kept after a report is deleted.