GitHub issues
Create a GitHub issue from a task, keep the customer private, and keep the task and the issue in step.
When a bug report needs a fix in your code, you can turn its task into a GitHub issue without retyping anything. For how the task is made, see Tasks from email.
Before you start
Section titled “Before you start”- GitHub is connected and the repository you want is linked to a project.
- The task came from an email. The button is in the task’s From email section, so it is there for tasks Plavn prepared from an email and for ones you made from one with Make a task. It is not shown for recurring tasks.
- The Plavn GitHub App may create issues. If it cannot, Plavn tells you what to change (see If creating fails).
Create an issue
Section titled “Create an issue”- Open the task and choose Create GitHub issue under From email.
- Choose the Repository. Only linked repositories are offered, with the ones that contain the suspect commits first, then those linked to the task’s project. If you have none, Plavn says to link one in Settings → GitHub first.
- Edit the Title and the Description (Markdown). The task’s title and a generated description are filled in.
- Choose Create issue.
The task then shows the issue as a small link, such as acme/app#42, with open or closed. Each task has at most one
issue.
What the description contains
Section titled “What the description contains”- Report: the customer’s email, quoted (without the earlier messages in the thread, and cut to the first 4,000 characters). For a task that did not come from an email, the task’s description instead.
- Analysis: what Plavn worked out from the email.
- Suspect commits, with the confidence, each linking to the commit and saying why it is suspected.
- A closing line, Created from Plavn, linking back to the task.
You can change all of it before creating the issue; what you send is what is posted.
Keep the customer private
Section titled “Keep the customer private”Issues are often public, so by default Plavn removes what identifies the customer from the report and the analysis:
| Removed | Replaced with |
|---|---|
| Email addresses | [email] |
| Phone numbers | [phone] |
| Links that carry a token, key, code or signature | [link] |
| The sender’s name (each part of it) | [name] |
The issue says the report came “by email” and that the sender is kept private.
To include them, tick Include the sender’s name and address. The description then shows the report as written and who sent it. Check what remains in the description before you create the issue: Plavn removes the obvious identifiers, but it cannot know everything a customer might write.
Keeping the task and the issue in step
Section titled “Keeping the task and the issue in step”- From GitHub to Plavn. When the issue is closed, reopened or opened on GitHub, the task shows it. A pull request that says “Fixes #42” closes the issue when it is merged, so merged fixes arrive here too.
- From Plavn to GitHub. When you complete a task that has an open issue, Plavn can close the issue. You answer Also close the GitHub issue? the first time and can tick Do this every time, or choose in Settings → Developer under When I complete a task with an open issue: Ask me, Close the issue or Leave it open. That choice is saved on this device only. Offline, the closing waits and is sent when you are back online. Plavn closes the issue as completed.
- Telling the customer. When a task from an email is completed, or its issue is closed, Plavn can prepare a short reply telling the sender it is done. See Tasks from email.
If creating fails
Section titled “If creating fails”- “The Plavn GitHub App cannot create issues yet…” The App needs permission to write issues. In GitHub, open the App’s permissions, set Issues to Read and write, and accept the update on your account or organization.
- Not found, or no access. The repository may have been removed from the App, or the App uninstalled. Check Connect GitHub.
- Plavn cannot reach GitHub. Try again in a moment.
Creating an issue needs a connection. Plavn limits how fast you can create issues, to protect your GitHub account.