From 1f368adaffacce1a27a03c13338f87cbfa67d410 Mon Sep 17 00:00:00 2001 From: Adrian Dombeck Date: Wed, 21 Aug 2024 17:31:32 +0200 Subject: [PATCH 1/7] GitHub issue template: Remove part about `ubuntu-bug authd` It currently doesn't provide a useful and well-formatted report. We want to provide a command in the GitHub template instead to gather relevant system information. refs: #470 --- .github/ISSUE_TEMPLATE/bug_report.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 71a2df1d8..b428bd6e0 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -10,7 +10,6 @@ body: Be careful with sensitive information and security vulnerabilities. In order to report bugs that could contain sensitive information, use [Launchpad](https://bugs.launchpad.net/ubuntu/+source/authd/+filebug) instead. - On Ubuntu machines, you can use `ubuntu-bug authd` to collect relevant information. Thanks for taking the time to report an issue and help improve authd! Please fill out the form below as From 6b2460b76e7cf8aaf9a1b64c0bd683e4fcd6b7a8 Mon Sep 17 00:00:00 2001 From: Adrian Dombeck Date: Wed, 21 Aug 2024 18:03:07 +0200 Subject: [PATCH 2/7] GitHub issue template: Remove some checkboxes We want to simplify the issue template to make it easier to fill out. I expect these checkboxes to not provide useful information in addition to the issue description, so lets try removing them. --- .github/ISSUE_TEMPLATE/bug_report.yml | 8 -------- 1 file changed, 8 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index b428bd6e0..5664ae81b 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -37,14 +37,6 @@ body: and see if you can reproduce the issue there too. State so in the description. validations: required: true - - type: checkboxes - attributes: - label: Where does the issue happens - options: - - label: I can reproduce the issue in the graphical display manager - required: false - - label: I can reproduce the issue on a terminal with "login" - required: false - type: textarea attributes: label: Steps to reproduce it From 0c1b670c0c2c91ecfe904ede07bb2a86e205dbbb Mon Sep 17 00:00:00 2001 From: Adrian Dombeck Date: Wed, 21 Aug 2024 18:11:17 +0200 Subject: [PATCH 3/7] GitHub issue template: Fix link to troubleshooting wiki page --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 5664ae81b..9c686ab48 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -100,7 +100,7 @@ body: attributes: label: Relevant information description: > - Please look at our [Troubleshooting guide](https://github.com/ubuntu/authd/wiki/05--Troubleshooting) and provide logs for both authd and the oidc provider package. + Please look at our [Troubleshooting guide](https://github.com/ubuntu/authd/wiki/06--Troubleshooting) and provide logs for both authd and the oidc provider package. placeholder: Remember to redact any sensitive information from them. - type: checkboxes attributes: From 05ee4ac08688506a9c945466063f4043016fc58e Mon Sep 17 00:00:00 2001 From: Adrian Dombeck Date: Wed, 21 Aug 2024 18:14:46 +0200 Subject: [PATCH 4/7] GitHub issue template: Link to troubleshooting at the top The main purpose of looking at the troubleshooting page is to help the user to solve their issue themselves. If they are able to do that, they don't need to fill out the rest of the form, so lets point to the troubleshooting doc at the top. The troubleshooting doc also explains how to enable debug logging. We could also ask our users to do that and try to reproduce the issue with debug logging, but that might be asking a bit much for non-technical users, and is often not necessary to solve the issue, so lets instead ask for that in a comment when we ascertain that we do need debug logs. --- .github/ISSUE_TEMPLATE/bug_report.yml | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 9c686ab48..bafcee444 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -15,11 +15,19 @@ body: Thanks for taking the time to report an issue and help improve authd! Please fill out the form below as best as you can so that we can help you. + Your additional work here is greatly appreciated and will help us respond as quickly as possible. For general support or usage questions, use [Ubuntu Discourse](https://discourse.ubuntu.com/c/desktop/8). + By submitting an Issue to this repository, you agree to the terms within the [Ubuntu Code of Conduct](https://ubuntu.com/community/code-of-conduct). + + + **Troubleshooting** + + Please read our [Troubleshooting wiki page](https://github.com/ubuntu/authd/wiki/06--Troubleshooting) + and see if you can find a solution to your problem there. - type: checkboxes attributes: label: Is there an existing issue for this? @@ -96,12 +104,6 @@ body: cat /etc/authd/brokers.d/msentraid.conf ``` - - type: textarea - attributes: - label: Relevant information - description: > - Please look at our [Troubleshooting guide](https://github.com/ubuntu/authd/wiki/06--Troubleshooting) and provide logs for both authd and the oidc provider package. - placeholder: Remember to redact any sensitive information from them. - type: checkboxes attributes: label: Double check your logs From 09449f4237638a083856471e4a621615e306425f Mon Sep 17 00:00:00 2001 From: Adrian Dombeck Date: Wed, 21 Aug 2024 18:20:47 +0200 Subject: [PATCH 5/7] GitHub issue template: Improve wording --- .github/ISSUE_TEMPLATE/bug_report.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index bafcee444..788c01dbe 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -40,17 +40,17 @@ body: description: > Provide a clear and concise description of what the issue is, including what you expected to happen. - Please precise if the option is in the graphical display manager or in the terminal. If it is with the graphical + Please specify if the option is in the graphical display manager or in the terminal. If it is with the graphical display manager, try to login with another local user, and open a terminal. Then, try to login with "login" and see if you can reproduce the issue there too. State so in the description. validations: required: true - type: textarea attributes: - label: Steps to reproduce it + label: Steps to reproduce description: > - Detail the steps taken to reproduce this error, what was expected, and whether this issue can be reproduced - consistently or if it is intermittent. + Specify the steps you took when you encountered the issue and which behavior you expected. + Are you able to reproduce the issue consistently? placeholder: | 1. In this environment... 2. With this config... From c26ccec7bc127d86f6f386e9d5cb6cf769cee5d5 Mon Sep 17 00:00:00 2001 From: Adrian Dombeck Date: Wed, 21 Aug 2024 18:21:32 +0200 Subject: [PATCH 6/7] GitHub issue template: Add command to show system information To make it easier for the user to provide all the information we want. This includes some rudimentary redaction of UUIDs like the issuer URL and client ID. --- .github/ISSUE_TEMPLATE/bug_report.yml | 78 ++++++++++++++------------- 1 file changed, 41 insertions(+), 37 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 788c01dbe..29af36392 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -64,45 +64,49 @@ body: attributes: label: "System information and logs" description: | - Provide details about the environment you experienced the issue in. Change msentraid for the provider you are using: - value: | - ### Environment - * broker version: please run `snap info authd-msentraid` - * authd version: please run `/usr/libexec/authd version` - * gnome shell version: please run `apt policy gnome-shell` - * Distribution: (**NAME** in `/etc/os-release`) - * Distribution version: (**VERSION_ID** on `/etc/os-release`): - - ### Log files - Please redact/remove sensitive information: - - #### Authd entries: - - ```raw - journalctl -u authd.service + Copy this command and run it in a terminal. It will open a text editor with the system information and logs. Paste the output below. Redact any sensitive information from the logs. + ```bash + TMPFILE=$(mktemp authd-system-info-XXXXXX.md) + if command -v xdg-open > /dev/null && [ -n "${DISPLAY:-}" ]; then EDITOR=xdg-open; elif [ -z "${EDITOR:-}" ]; then EDITOR=editor; fi + cat > "$TMPFILE" </dev/null) + \`\`\` + + #### gnome-shell version + \`\`\` + $(apt policy gnome-shell 2>/dev/null) + \`\`\` + + #### Distribution + \`\`\` + $(lsb_release -a) + \`\`\` + + #### Logs + \`\`\` + $(journalctl -o short-monotonic --lines 500 _SYSTEMD_UNIT=authd.service \+ UNIT=authd.service \+ _SYSTEMD_UNIT=snap.authd-msentraid.authd-msentraid.service \+ UNIT=snap.authd-msentraid.authd-msentraid.service \+ '_CMDLINE="gdm-session-worker [pam/gdm-authd]"' | sed -E 's/[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}//g') + \`\`\` + + #### authd broker configuration + $(if ! find /etc/authd/brokers.d -name '*.conf' | grep -q .; then echo ":warning: No config files in /etc/authd/brokers.d/"; else for f in /etc/authd/brokers.d/*.conf; do echo "#### $f"; echo "\`\`\`"; cat $f; echo "\`\`\`"; done; fi) + + #### authd-msentraid configuration + \`\`\` + $(cat 2>&1 /var/snap/authd-msentraid/current/broker.conf | sed -E 's/[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}//g') + \`\`\` + EOF ``` - #### MS Entra ID broker entries: - - ```raw - journalctl -u snap.authd-msentraid.authd-msentraid.service - ``` - - ### Application settings - - Please redact/remove sensitive information: - - #### Broker configuration: - - ```raw - cat /var/snap/authd-msentraid/current/broker.conf - ``` - - #### Broker authd configuration: - - ```raw - cat /etc/authd/brokers.d/msentraid.conf - ``` + placeholder: > + Paste the output of the above command here. Redact any sensitive + information from the logs. - type: checkboxes attributes: From a64a3db4d674dd833e509893aa6be4153e70d3cb Mon Sep 17 00:00:00 2001 From: Adrian Dombeck Date: Wed, 21 Aug 2024 18:49:21 +0200 Subject: [PATCH 7/7] GitHub issue template: Don't require steps to reproduce We are trying to make the issue template easier to fill out. While steps to reproduce are often very useful, there are issues which they don't really apply to, or are not necessary. Lets try to make them not required and see how it turns out. --- .github/ISSUE_TEMPLATE/bug_report.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 29af36392..6fc68a77a 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -59,7 +59,7 @@ body: Please include screenshots (you can drag any image here) where applicable. Redact any sensitive information. validations: - required: true + required: false - type: textarea attributes: label: "System information and logs" @@ -67,8 +67,8 @@ body: Copy this command and run it in a terminal. It will open a text editor with the system information and logs. Paste the output below. Redact any sensitive information from the logs. ```bash TMPFILE=$(mktemp authd-system-info-XXXXXX.md) - if command -v xdg-open > /dev/null && [ -n "${DISPLAY:-}" ]; then EDITOR=xdg-open; elif [ -z "${EDITOR:-}" ]; then EDITOR=editor; fi - cat > "$TMPFILE" < /dev/null && [ -n "${DISPLAY:-}" ]; then authd_editor=xdg-open; elif [ -n "${EDITOR:-}" ]; then authd_editor=$EDITOR; fi + cat > "$TMPFILE" <