Skip to content

Adds option to generate a bug report in GitHub #963

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 23, 2017
Merged

Adds option to generate a bug report in GitHub #963

merged 3 commits into from
Oct 23, 2017

Conversation

PowerSchill
Copy link
Contributor

This pull request adds the ability to generate a bug report for the extension by collecting operating system, vscode, and PowerShell information and inserting it into a new GitHub issues entry.

Key Points:

  • The project to generate the issue in is configurable and can be set in the settings. It defaults to the main PowerShell repository.
  • Log files are not handled with this submission. However attempting to facilitate the inclusion of log files is still desired.

This PR will resolve #820.

Below is an example output

Issue Description

I am experiencing a problem with...

Attached Logs

Follow the instructions in the README about capturing and sending logs.

Environment Information

Visual Studio Code

Name Version
Operating System Darwin x64 16.6.0
VSCode 1.15.0-insider
PowerShell Extension Version 1.4.1

PowerShell Information

Name Value
PSVersion 6.0.0-beta
PSEdition Core
BuildVersion 3.0.0.0
CLRVersion
GitCommitId v6.0.0-beta.2
OS Darwin 16.6.0 Darwin Kernel Version 16.6.0: Fri Apr 14 16:21:16 PDT 2017, root:xnu-3789.60.24~6/RELEASE_X86_64
Platform Unix
PSCompatibleVersions 1.0 2.0 3.0 4.0 5.0 5.1.10032.0 6.0.0
PSRemotingProtocolVersion 2.3
SerializationVersion 1.1.0.1
WSManStackVersion 3.0

Visual Studio Code Extensions

Visual Studio Code Extensions(Click to Expand)
Extension Author Version
Bookmarks alefragnani 0.15.2
bracketselection guosong 1.0.3
Chef Pendrica 0.6.3
code-settings-sync Shan 2.8.2
copy-github-url mattlott 0.1.0
copy-markdown-as-html jerriepelser 1.0.0
csharp ms-vscode 1.11.0
fontsize-shortcuts peterjuras 1.3.0
gc-excelviewer GrapeCity 1.1.15
githistory donjayamanne 0.2.1
gitignore codezombiech 0.5.0
gitlens eamodio 4.3.1
indenticator SirTori 0.4.2
licenser ymotongpoo 1.0.1
markdown-shortcuts mdickin 0.8.1
markdown-toc AlanWalk 1.5.5
path-intellisense christian-kohler 1.4.2
PowerShell ms-vscode 1.4.1
prettify-json mohsen1 0.0.3
sublime-keybindings ms-vscode 2.9.1
theme-sapphire Tyriar 0.2.1
todotasks sandy081 0.5.0
tslint eg2 0.16.0
vscode-gist dbankier 0.5.3
vscode-icons robertohuertasm 7.10.1
vscode-markdownlint DavidAnson 0.9.1
vscode-paste-image mushan 0.9.4
vscode-table-formatter shuworks 1.1.2
vscode-todo-parser minhthai 1.9.0

Copy link
Contributor

@daviwil daviwil left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, thanks so much for putting this together! One comment here but it's not critical. I'll merge it whenever you're ready.

this.command = vscode.commands.registerCommand('PowerShell.GenerateBugReport', () => {


var OutputChannel = window.createOutputChannel('Debug');
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can use the ILogger interface for this instead of an output channel, it'll go to the PowerShell Extension Logs channel.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, actually that was just used for debugging my code. I will remove it. Unless you think it would be beneficial to put the information into the log file.

@daviwil
Copy link
Contributor

daviwil commented Oct 23, 2017

Thanks again for doing this, Mark! Sorry it took me so long to get it merged :)

@daviwil daviwil merged commit 85b967a into PowerShell:master Oct 23, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a "Report a problem on GitHub" command that automates filing a bug on GitHub
4 participants