From 40ab349c66f20c2c2e3e5e82c79888279536bccc Mon Sep 17 00:00:00 2001 From: denisonbarbosa Date: Thu, 22 Jun 2023 09:03:01 -0400 Subject: [PATCH 1/3] Apply issue template changes to the repo With https://github.com/canonical/desktop-engineering/pull/2, we defined some yaml forms to be used as issue templates for reporting bugs and requesting features on GitHub. This provides a better and more defined way for users to interact with us and provide us with the relevant information we need to solve the problem. --- .github/ISSUE_TEMPLATE/bug_report.yml | 96 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 91 ++++++++++++++++++++ 2 files changed, 187 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..d726ccadd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,96 @@ +name: Report an issue +description: Create a bug report to fix an issue +title: 'Issue: ' +labels: 'bug' +body: + - type: markdown + attributes: + value: > + :warning: **Please do not report security vulnerabilities here** + + 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/adsys/+filebug) instead. + On Ubuntu machines, you can use `ubuntu-bug adsys` to collect relevant information. + + + Thanks for taking the time to report an issue and help improve adsys! 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). + - type: checkboxes + attributes: + label: Is there an existing issue for this? + options: + - label: I have searched the existing issues and found none that matched mine + required: true + - type: textarea + attributes: + label: Describe the issue + description: > + Provide a clear and concise description of what the issue is, including what you expected to happen. + validations: + required: true + - type: textarea + attributes: + label: Steps to reproduce it + 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. + placeholder: | + 1. In this environment... + 2. With this config... + 3. Run '...' + 4. See error... + + Please include screenshots (you can drag any image here) where applicable. Redact any sensitive information. + validations: + required: true + - type: textarea + attributes: + label: "Ubuntu users: System information" + description: > + Ubuntu users can run `ubuntu-bug adsys --save=/tmp/report.txt` and drag the file below. + + It will contain useful information pertaining to the system and the packages installed. + - type: textarea + attributes: + label: "Non Ubuntu users: System information" + description: | + For users of distributions other than Ubuntu, provide details about the environment you experienced the issue in: + value: | + ### Environment + * adsys version: please run `adsysctl version` + * Distribution: (**NAME** in `/etc/os-release`) + * Distribution version: (**VERSION_ID** on `/etc/os-release`): + + ### Log files + Please redact/remove sensitive information: + ```raw + adsys service logs can be acquired by running `adsysctl service cat -v`. + You can increase the amount of information displayed by increasing the verbosity level (-v) to -vv or -vvv. + ``` + + ### Application settings + Please redact/remove sensitive information: + ```raw + Paste the contents of your adsys.yaml file here, if you created one. + ``` + - type: textarea + attributes: + label: Additional information + description: > + Should there be any other contextual information that might be useful, please provide it here. + Please take a look at our [Troubleshooting guide](../#troubleshooting) to understand a bit more about what you + can do to get more information and logs about the project. + placeholder: Remember to redact any sensitive information from them. + - type: checkboxes + attributes: + label: Double check your logs + options: + - label: I have redacted any sensitive information from the logs + required: true + diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..198a69dbd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,91 @@ +name: Request a feature +description: Suggest new functionality or improvements for this project +title: 'Feature: ' +labels: 'feature' +body: + - type: markdown + attributes: + value: > + :warning: **Please do not report security vulnerabilities here** + + 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/adsys/+filebug) instead. + On Ubuntu machines, you can use `ubuntu-bug adsys` to collect relevant information. + + + Thanks for taking the time to report an issue and help improve adsys! 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). + - type: checkboxes + attributes: + label: Is there an existing request for this feature? + options: + - label: I have searched the existing issues and found none that matched mine + required: true + - type: textarea + attributes: + label: Describe the feature + description: > + A clear and concise description of what the problem is. Ex.: \"I'm always frustrated when ...\" + validations: + required: true + - type: textarea + attributes: + label: Describe the ideal solution + description: > + A clear and concise description of what you want to happen. + - type: textarea + attributes: + label: Alternatives and current workarounds + description: > + A clear and concise description of any alternatives you've considered or any workarounds that are currently in + place. + - type: textarea + attributes: + label: "Ubuntu users: System information" + description: > + Ubuntu users can run `ubuntu-bug adsys --save=/tmp/report.txt` and drag the file below. + + It will contain useful information pertaining to the system and the packages installed. + - type: textarea + attributes: + label: "Non Ubuntu users: System information" + description: | + For users of distributions other than Ubuntu, provide details about the environment you experienced the issue in: + value: | + ### Environment + * adsys version: please run `adsysctl version` + * Distribution: (**NAME** in `/etc/os-release`) + * Distribution version: (**VERSION_ID** on `/etc/os-release`): + + ### Log files + Please redact/remove sensitive information: + ```raw + adsys service logs can be acquired by running `adsysctl service cat -v`. + You can increase the amount of information displayed by increasing the verbosity level (-v) to -vv or -vvv. + ``` + + ### Application settings + Please redact/remove sensitive information: + ```raw + Paste the contents of your adsys.yaml file here, if you created one. + ``` + - type: textarea + attributes: + label: Additional information + description: > + Should there be any other contextual information that might be useful, please provide it here. + Please take a look at our [Troubleshooting guide](../#troubleshooting) to understand a bit more about what you + can do to get more information and logs about the project. + placeholder: Remember to redact any sensitive information from them. + - type: checkboxes + attributes: + label: Double check your logs + options: + - label: I have redacted any sensitive information from the logs + required: true From b71122f9dbc7178c7bd751b7da70d118830429e3 Mon Sep 17 00:00:00 2001 From: denisonbarbosa Date: Thu, 22 Jun 2023 09:03:37 -0400 Subject: [PATCH 2/3] Add troubleshoot section to README.md The new issue template pattern relies on the project having a troubleshoot section on the main page --- README.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/README.md b/README.md index d79e88017..143d36635 100644 --- a/README.md +++ b/README.md @@ -1372,3 +1372,40 @@ adsysd runscripts ORDER_FILE [flags] For every commit on the `main` branch of the `adsys` repository, the GitHub Actions CI builds a development version of the `adwatchd` project. This is *NOT* a stable version of the application and should not be used for production purposes. However, it may prove useful to preview features or bugfixes not yet available as part of a stable release. To get access to the build artifact you need to be logged in on GitHub. Then, click on any passing run of the [QA workflow](https://github.com/ubuntu/adsys/actions/workflows/qa.yaml) that has the `Windows tests for adwatchd` job, and look for the `adwatchd_setup` file. + +## Troubleshooting + +If AD authentication works but adsys fails to fetch GPOs (e.g. you see `can't get policies` errors on login), please perform the following steps: + +1. Add the following to `/etc/samba/smb.conf`: + +```text +log level = 10 +``` + +2. Run `sudo login {user}@{domain}` in a terminal, replacing with your AD credentials + +3. Paste the output in the bug report + +The `adsysctl` command can also be useful to fetch logs for the daemon and client: + +```bash +# You can increase the amount of information that will be displayed by using a more verbose tag (-vv or -vvv). +# Note that this command will start a watcher that will print logs as they are generated, so you will need to perform +# actions (such as trying to login) while the command is running. +adsysctl service cat -v +``` + +Additionally, you can check the system journal to look at more logs about adsys: +Remember that adsys runs with privileges, so you will need to run the following commands as root. + +```bash +# You can use the -b flag to control how many boots the log will show (e.g. -b 0 will show the current boot only) +journalctl -b0 | grep adsys + +# You can also get the logs of the individual units: +systemctl list-units | grep adsys # this will show all adsys related systemd units + +# The -u flag will show the logs of the specified unit +journalctl -b0 -u adsysd.service # this command will only show the adsysd.service logs of the current boot +``` From d0a041861adb9c8ad7dfce7397138e207a7516f7 Mon Sep 17 00:00:00 2001 From: denisonbarbosa Date: Thu, 22 Jun 2023 09:04:19 -0400 Subject: [PATCH 3/3] Remove old markdown templates --- .github/ISSUE_TEMPLATE/bug_report.md | 63 ----------------------- .github/ISSUE_TEMPLATE/feature_request.md | 49 ------------------ 2 files changed, 112 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 3eede624f..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -name: Report an issue -about: Create a bug report to fix an existing issue. -title: '' -labels: '' -assignees: '' - ---- ->**Please do not report security vulnerabilities here** ->Use [launchpad ADSys private bugs](https://bugs.launchpad.net/ubuntu/+source/adsys/+filebug) which is monitored by our security team. On Ubuntu machines, it’s best to use `ubuntu-bug adsys` to collect relevant information. - -**Thank you in advance for helping us to improve ADSys!** -Please read through the template below and answer all relevant questions. 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). Finally, to avoid duplicates, please search existing Issues before submitting one here. - -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). - -## Description - -> Provide a clear and concise description of the issue, including what you expected to happen. - -## Reproduction - -> Detail the steps taken to reproduce this error, what was expected, and whether this issue can be reproduced consistently or if it is intermittent. -> -> Where applicable, please include: -> -> * Code sample to reproduce the issue -> * Log files (redact/remove sensitive information) -> * Application settings (redact/remove sensitive information) -> * Screenshots - -### Environment - -> Please provide the following: - -#### For Ubuntu users, please run and copy the following - -1. `ubuntu-bug adsys --save=/tmp/report` -1. Copy paste below `/tmp/report` content: - -```raw -COPY REPORT CONTENT HERE. -``` - -#### Relevant AD information - -If AD authentication works but adsys fails to fetch GPOs (e.g. you see `can't get policies` errors on login), please perform the following steps: - -1. Add the following to `/etc/samba/smb.conf`: -``` -log level = 10 -``` -2. Run `sudo login user@domain` in a terminal, replacing with your AD credentials -3. Paste the output in the bug report - -#### Installed versions - -* OS: (`/etc/os-release`) -* ADSys version: (`adsysctl version` output) - -#### Additional context - -> Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 16760e612..000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -name: Feature request -about: Suggest new functionality for this project. -title: '' -labels: 'feature' -assignees: '' - ---- ->**Please do not report security vulnerabilities here** ->Use [launchpad ADSys private bugs](https://bugs.launchpad.net/ubuntu/+source/adsys/+filebug) which is monitored by our security team. On ubuntu machine, it’s best to use `ubuntu-bug adsys` to collect relevant information. - -**Thank you in advance for helping us to improve ADSys!** -Please read through the template below and answer all relevant questions. 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). Finally, to avoid duplicates, please search existing Issues before submitting one here. - -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). - -## Describe the problem you'd like to have solved - -> A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -## Describe the ideal solution - -> A clear and concise description of what you want to happen. - -## Alternatives and current workarounds - -> A clear and concise description of any alternatives you've considered or any workarounds that are currently in place. - -### Environment - -> Please provide the following: - -#### For ubuntu users, please run and copy the following - -1. `ubuntu-bug adsys --save=/tmp/report` -1. Copy paste below `/tmp/report` content: - -```raw -COPY REPORT CONTENT HERE. -``` - -#### Installed versions - -* OS: (`/etc/os-release`) -* ADSys version: (`adsysctl version` output) - -#### Additional context - -> Add any other context about the problem here.