microsoft/azure-boards-vscode

Azure Boards Extension for Visual Studio Code

Azure Boards Extension for Visual Studio Code

This extension provides easy access to your Azure Boards work items, directly from within Visual Studio Code. See the work assigned to you, work you've recently had activity on, work you've been mentioned on, and work you're following. You can open a work item to gather more context or make an edit. Once you're ready to commit, starting a commit message that includes a work item mention is just a click away.

Prerequisites

Azure DevOps Services

If you are using the extension with Azure DevOps Services, ensure you have an Azure DevOps Services organization. If you do not have one, sign up for Azure DevOps Services.

Azure DevOps Server / Team Foundation Server

Azure DevOps Server and Team Foundation Server are not yet supported.

Installation

First, you will need to install Visual Studio Code 1.30.0 or later.

To install the extension with the latest version of Visual Studio Code (version 1.30.0 is the latest as of this writing), bring up the Visual Studio Code Command Palette (F1), type install and choose Extensions: Install Extensions. In the Search Extensions in Marketplace text box, type azure boards. Find the Azure Boards extension published by Microsoft and click the Install button. Restart Visual Studio Code.

Mentioning work items in a commit message

Clicking the mention icon on a work item within the extension automatically switches over to Source Control and adds the work item ID mention to the commit message.

• Azure Repos: #[work item id]
• GitHub.com: AB#[work item id]

Note: GitHub Enterprise Server support for prefixing with AB# is on the backlog.

Further development and roadmap

This extension is in active development. While we believe the feature scenarios are fairly limited for this extension, if you do have a feature suggestion, go ahead and log it in our issue list or participate in discussions about existing suggestions.

Check our issue list for enhancements we plan to make. You'll notice that some are set to a project, which indicates our intent to deliver.

Support

Support for this extension is provided on our GitHub Issue Tracker. You can submit a bug report, a feature suggestion or participate in discussions.

Contributing to the Extension

See the developer documentation for details on how to contribute to this extension.

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Privacy Statement

The Microsoft Privacy Statement describes the privacy statement of this software.

Data/Telemetry

This project collects usage data and sends it to Microsoft to help improve our products and services. Read Microsoft's privacy statement to learn more.

Reporting Security Issues

Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC) at [email protected]. You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Further information, including the MSRC PGP key, can be found in the Security TechCenter.

License

This extension is licensed under the MIT License. Please see the third-party notices file for additional copyright notices and license terms applicable to portions of the software.

azure-boards-vscode's Issues

Azure Boards is not showing the vscode marketplace

I did a search for it both on the website and in app...the extension does not show up.

Command icon colors blur with work item titles

Reported by @bcarthic on 0.0.7

With long work item titles, the text blurs with the hover command icons, making it tougher to see and know that those are commands vs. emojis or something in the title itself.

remove WIQL and use the search api

start with just assigned to me and maybe my activity

isValidAzureBoardsUrl check for visualstudio.com URL

azure-boards-vscode/src/configuration/url.ts

Line 6 in 026eb8a

(url.startsWith("https://") && url.indexOf(".visualstudio.com") >= 0)

Seems like there could be URLs that meet this check but aren't actual Azure DevOps Services URLs. https://asdf.visualstudio.com.badactor.com

Any consequence of that?

Figure out publisher to use

• Microsoft DevLabs
  or
• Microsoft

list of work items should display wit icon, number, title

azure-boards.organizations goes in user settings but azure-boards.current-organization goes in workspace settings

I would expect all settings to go in the user settings by default?

Use predefinedqueries api for getting work items (do not use search provider)

CI/CD pipeline in public project within MSEng publishing to VS Marketplace?

load work item icons and cache instead of loading for each parent node

we are loading the work item type icons for the project each time the user click on the parent tree. we really should be loading that once and caching it for reuse.

Test issue

Add GitHub Enterprise Server mention support and fallback when neither GitHub nor Azure Repos

Either figure out how to identify GitHub Enterprise Server, or switch to identify Azure Repos for "#" and otherwise "AB#". However, there could be a repo not GitHub nor Azure Repos.. in that case, should also figure out how to hide the mention command.

Sort list of projects alphabetically

Use the correct Azure DevOps icon

change out to use the right icon

Edit/Mention icons don't look good with a light theme

Check if we can limit OAuth scopes

The WIT apis should just require work.read, we need to check what's required for reading the list of projects.

Microsoft Open Source release checklist

Preparation

• Successfully completed a release registration and review.
• Completed an Intellectual Property (IP) scan of the code to be released, if required.
• The project uses consistent code conventions, clear function/method/variable names, and a sensible public API.
• The code is clearly commented, documenting intentions and edge cases.
• The project has a name that is easy to remember, gives some idea what the project does, and does not conflict with an existing project or infringe on any trademarks.
• The distribution mechanism is as convenient, standard, and low-overhead as possible (RubyGems, Homebrew, Bower, Maven, NuGet, and so on.)
• At least two team members have access to release new versions.
• The process for releasing a new version is clearly documented.
• There are no sensitive materials in the commit history, issues, or pull requests.
• The project uses publicly-accessible continuous integration that integrates with the status API.
• The process for contributing is clearly documented in the README.md or CONTRIBUTING.md.
• All licensing and legal concerns have been addressed.
• Has LICENSE file(s) in the approved format.

README.md

• Starts with a one-line description that explains what the project is about, who might be interested in it, what language it is written in, and how it might be different from similar projects.
• Includes a list of features and limitations.
• States the goals and scope of the project to help set expectations and filter proposed changes down the line.
• Includes the current status (for example, proof of concept, used in production, active development, orphaned, and so on.)
• Includes a description of the kind of environment required to run the software and instructions for setting it up.
• Includes a link to the Microsoft Open Source Code of Conduct. See How does a project adopt the code and process? for details.
• Clearly states the external dependencies and directions for installing them.
• Includes a high-level development roadmap or link to open issues/milestones.
• Explicitly asks for contributions, if you want them, with information on how to contribute and/or a link to a CONTRIBUTING.md file.
• Includes a pointer to where questions should be asked and how the development team can be contacted.
• Includes information on how to privately report security vulnerabilities (to MSRC).

Ship it

• Double check/confirm that all sensitive material has been removed from commit history, issues, and pull requests.
• Make the repository public.
• Tweet about it from your personal account.
• If it makes sense, blog about this project.

Going forward

• At least one team member is committed to managing community interactions by triaging and responding to issues, giving feedback, merging pull requests, and releasing new versions.
• At least one team member is committed to pulling each release into our products that depend on this project.

Activating extension error related to keytar

Error during extension activation when debugging locally related to keytar package.

Related: atom/node-keytar#51

Workaround: Use VS Code Insiders.

Refresh button to refresh the list of work items

Work item status filter

Requested by @bcarthic on 0.0.7

Given the large number of work items in the pivots, would be nice to have a filter on status.

add the ability update status of work items to keep team members informed

I'd like this extension to do more for me. I personally don't have many things assigned to me.
I'd like to:

• see all the tasks in the sprint
• see it's status todo/in progress/done
• do the most common action, which is to change it's status from todo -> in progress (done is completed via merging a PR)

The most common task I have is keeping tickets up to date. Either moving from 'To Do' to 'In Progress'.

Wire up application insights to get usage telemetry

• Loading extension
• Clicking on each tree node
• Editing an item, opening in web
• Linking to a commit

Can't find installation

I'm searching for this extension in VSCode 1.36.1 on MacOS, but it's not showing up in the extensions list. Has it been released? Do I need to change any settings to be able to find this extension in the search?

Figure out user interface

Probably just the tree view, and if no connection is active display some zero data message, similar to the repository default view

Update extension manifest for publishing

• Update manifest
• Good marketplace description
• Get boards icon
• Add ourselves to the Microsoft publisher

Boards Account selection

Need to figure out how we can associate a work space with a Boards.

• Can we automatically determine that from the GH metadata somehow?
• Do we tell users to add a workspace config file?
• Do we store it in the context? (see https://code.visualstudio.com/api/references/vscode-api#ExtensionContext)

Open the pane with the first group open, after connection

Saves a click. Start with "Assigned To Me" pivot group open.

When selecting an organization and canceling before project we end up in an invalid state

Workaround: Undo/remove the settings.json change to your working tree that the extension generates after selecting the org.

Call Search to get work items

Add support for quick create work item action when I am trying to link

Some of the times, I may work on an issue where the actual workitem is not created. It would be helpful if we can create quick workitem when I am trying to link.

Show account and project connected to in status bar

Update README for public

Be able to browse to a work item in the web

Settings page

Allow creating an issue from entry points in VS Code

Example:

• // TODO comment in source files - work item should contain context information abount file ideally

Add config to turn off telemetry collection

See: https://docs.opensource.microsoft.com/releasing/overview.html#initializing-your-repository
Related to #73

With this, also mention how to use the setting in the README.

Reverse the list of work items in each tree. Currently the list is showing most recent at the bottom

• show most recent first
• show only top 50
• do not show completed

https://dev.azure.com/basicprocess/VSCodeTest/_apis/work/predefinedQueries/AssignedToMe?$top=5&includeCompleted= false

Navigate to SCM on work item mention

Populating with the work item mention is great but could use some work to make it more intuitive and ensure proper mention syntax.

• On invoking the mention command, navigate to the source control panel (SCM).
• Figure out if we can determine if the source control provider is GitHub, in which case the mention syntax calls for "AB#" rather than just "#" for Azure Repos.
• Double-down on this being through the work item click, move to context menu option, or have both.

Authentication

We need to figure out how we can authenticate the user. Most likely just ask for a PAT, but

• Where store it?
• Is it per repo/folder/workspace or per user?

See also this https://github.com/Microsoft/azure-repos-vscode/tree/master/src/credentialstore for storing credentials and this video (about half way in) for the "new" experience.

Enable pinned queries like in the vscode repo extension

Start with just config driven (no ux experience besides showing the status bar icon)

adding organization fails when workspace not open

1. open vs code without a work space
2. click on boards extension hub
3. click on 'add boards organization url'
4. select 'dev.azure.com/mseng'

actual: nothing happens, if you open dev tools you see a 'workspace not open error'
expected: there should be some alert that I need to open a workspace.