Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
58 commits
Select commit Hold shift + click to select a range
9ca53d4
Updated SDK, API and UI Versions (#140)
lohitakshgupta May 2, 2023
6dbdf49
xml2js resolved successfully (#141)
lohitakshgupta May 11, 2023
05b8849
Removing node-sass and request and adding sass instead
lohitakshgupta May 11, 2023
af457b6
Force legacy-peer-deps
dpaquette May 12, 2023
6de8a97
Merge pull request #142 from microsoft/resolve-node-sass
May 12, 2023
3655c72
initial
bworline Apr 7, 2024
5eb3645
CR comments: change scss common import
bworline Apr 17, 2024
c877493
Merge pull request #153 from bworline/widget-sample
dianagalarza Apr 25, 2024
e1ab7b5
Adding sample for backlog-item-menu contribution point
danhellem May 8, 2024
d77ddad
fixed manifest
danhellem May 9, 2024
6b48253
Merge pull request #156 from microsoft/users/danhellem/backlog-item-m…
danhellem May 13, 2024
bd35772
sample for work-hub-group
danhellem Jun 7, 2024
1dd7f83
Merge pull request #159 from microsoft/users/danhellem/work-hub-group-1
danhellem Jun 7, 2024
0932ddc
hub group samples and doc update
danhellem Jun 13, 2024
311e1f5
Merge pull request #160 from microsoft/users/danhellem/work-hub-group-1
danhellem Jun 13, 2024
b73e2e8
more samples to match docs
danhellem Jun 20, 2024
efeb336
clean up and adding project context to show on tab or page
danhellem Jun 26, 2024
a665c7f
Merge pull request #162 from microsoft/users/danhellem/samples-boards-1
danhellem Jun 26, 2024
f8fc347
Adding new boards samples
danhellem Jun 28, 2024
bce3c6a
Merge pull request #164 from microsoft/users/danhellem/samples-5
danhellem Jul 1, 2024
7404f8e
adding backlog-toolpane sample
danhellem Jul 2, 2024
afb446f
updating code samples and refactoring examples
danhellem Jul 3, 2024
d5a51af
Fixed build issues with file name
danhellem Jul 3, 2024
1184b66
reanme widget to widget-catalog to match manifest
danhellem Jul 3, 2024
344f8dd
fixes to naming to march contribution point
danhellem Jul 3, 2024
42cfb48
fix to readme
danhellem Jul 3, 2024
60e81d6
Merge pull request #165 from microsoft/users/danhellem/samples-6
danhellem Jul 6, 2024
bc0a8d3
fixing uri on widget manifests
danhellem Jul 15, 2024
2bccee7
Merge pull request #166 from microsoft/users/danhellem/fix-widgets-1
danhellem Jul 15, 2024
b20630e
Added multiple samples for pipelines menu and toolbars
danhellem Aug 8, 2024
8beb731
Added release-definition-explorer-context-menu
danhellem Aug 8, 2024
7cc50cd
Added release-definition-explorer-context-menu
danhellem Aug 8, 2024
ca18588
Fixing publisher information
danhellem Aug 8, 2024
9c9f939
Merge pull request #167 from microsoft/users/danhellem/pipelines-menu…
danhellem Aug 8, 2024
39c1e8d
pipelines samples and updating readme
danhellem Sep 3, 2024
9a9e0be
Merge pull request #169 from microsoft/users/danhellem/pipelines-exte…
danhellem Sep 5, 2024
0141e1a
Samples for azure repos menu and toolbar
danhellem Oct 10, 2024
2b9c131
Fix to git-commit-list-menu
danhellem Oct 11, 2024
1072778
Merge pull request #175 from microsoft/users/danhellem/azure-repos-me…
danhellem Oct 11, 2024
86c6465
Azure Test Plans menu and toolbar samples
danhellem Oct 11, 2024
e2e699a
Merge pull request #176 from microsoft/users/danhellem/azure-test-pla…
danhellem Oct 11, 2024
dc57edb
fix casing for samples in links on readme
danhellem Oct 16, 2024
9460421
removed build status icon
danhellem Oct 16, 2024
fa255fa
Merge pull request #177 from microsoft/users/danhellem/fixes-to-casin…
danhellem Oct 16, 2024
10142a5
Fix backlog-board-card-item-menu click not working
ZarekParker Jan 16, 2025
2eca19e
Added board and sprint panels for samples
mattiasen1 Feb 28, 2025
11534f3
Added name property on panel content
mattiasen1 Mar 18, 2025
ba4cba3
Added more panel/modal samples to boards, backlogs, sprints, queries
mattiasen1 Apr 1, 2025
f3291e8
Removed old contributions and replaced with new using panel/modal
mattiasen1 Apr 3, 2025
27115ea
Merge pull request #186 from solidify/modal-panel-samples
danhellem Apr 3, 2025
a383a2b
Merge pull request #182 from ZarekParker/master
danhellem Apr 3, 2025
486d35d
Fixed broken backlog toolpane, added panels to other contribution points
mattiasen1 Apr 9, 2025
e635328
Fixed broken backlog toolpane, added panels to other contribution points
mattiasen1 Apr 9, 2025
db9810e
Removed unused imports
mattiasen1 Apr 9, 2025
a2dc480
Merge pull request #188 from solidify/more-modal-samples
danhellem Apr 9, 2025
f6bf5a8
Add LICENSE file
mmmenacekdevildezign-sys Apr 24, 2026
12143bc
Add GitHub Actions workflow for Jekyll site CI
mmmenacekdevildezign-sys Apr 24, 2026
d358669
Add CodeQL analysis workflow configuration
mmmenacekdevildezign-sys Apr 24, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
101 changes: 101 additions & 0 deletions .github/workflows/codeql.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
# For most projects, this workflow file will not need changing; you simply need
# to commit it to your repository.
#
# You may wish to alter this file to override the set of languages analyzed,
# or to provide custom queries or build logic.
#
# ******** NOTE ********
# We have attempted to detect the languages in your repository. Please check
# the `language` matrix defined below to confirm you have the correct set of
# supported CodeQL languages.
#
name: "CodeQL Advanced"

on:
push:
branches: [ "master" ]
pull_request:
branches: [ "master" ]
schedule:
- cron: '28 13 * * 1'

jobs:
analyze:
name: Analyze (${{ matrix.language }})
# Runner size impacts CodeQL analysis time. To learn more, please see:
# - https://gh.io/recommended-hardware-resources-for-running-codeql
# - https://gh.io/supported-runners-and-hardware-resources
# - https://gh.io/using-larger-runners (GitHub.com only)
# Consider using larger runners or machines with greater resources for possible analysis time improvements.
runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
permissions:
# required for all workflows
security-events: write

# required to fetch internal or private CodeQL packs
packages: read

# only required for workflows in private repositories
actions: read
contents: read

strategy:
fail-fast: false
matrix:
include:
- language: actions
build-mode: none
- language: javascript-typescript
build-mode: none
# CodeQL supports the following values keywords for 'language': 'actions', 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'rust', 'swift'
# Use `c-cpp` to analyze code written in C, C++ or both
# Use 'java-kotlin' to analyze code written in Java, Kotlin or both
# Use 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both
# To learn more about changing the languages that are analyzed or customizing the build mode for your analysis,
# see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning.
# If you are analyzing a compiled language, you can modify the 'build-mode' for that language to customize how
# your codebase is analyzed, see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages
steps:
- name: Checkout repository
uses: actions/checkout@v4

# Add any setup steps before running the `github/codeql-action/init` action.
# This includes steps like installing compilers or runtimes (`actions/setup-node`
# or others). This is typically only required for manual builds.
# - name: Setup runtime (example)
# uses: actions/setup-example@v1

# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v4
with:
languages: ${{ matrix.language }}
build-mode: ${{ matrix.build-mode }}
# If you wish to specify custom queries, you can do so here or in a config file.
# By default, queries listed here will override any specified in a config file.
# Prefix the list here with "+" to use these queries and those in the config file.

# For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
# queries: security-extended,security-and-quality

# If the analyze step fails for one of the languages you are analyzing with
# "We were unable to automatically build your code", modify the matrix above
# to set the build mode to "manual" for that language. Then modify this step
# to build your code.
# ℹ️ Command-line programs to run using the OS shell.
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
- name: Run manual build steps
if: matrix.build-mode == 'manual'
shell: bash
run: |
echo 'If you are using a "manual" build mode for one or more of the' \
'languages you are analyzing, replace this with the commands to build' \
'your code, for example:'
echo ' make bootstrap'
echo ' make release'
exit 1

- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v4
with:
category: "/language:${{matrix.language}}"
20 changes: 20 additions & 0 deletions .github/workflows/jekyll-docker.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: Jekyll site CI

on:
push:
branches: [ "master" ]
pull_request:
branches: [ "master" ]

jobs:
build:

runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4
- name: Build the site in the jekyll/builder container
run: |
docker run \
-v ${{ github.workspace }}:/srv/jekyll -v ${{ github.workspace }}/_site:/srv/jekyll/_site \
jekyll/builder:latest /bin/bash -c "chmod -R 777 /srv/jekyll && jekyll build --future"
1 change: 1 addition & 0 deletions .npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
legacy-peer-deps = true
34 changes: 17 additions & 17 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
MIT License
MIT License

Copyright (c) Microsoft Corporation. All rights reserved.
Copyright (c) 2026 mmmenacekdevildezign-sys enrique ramirez

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
72 changes: 69 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Azure DevOps Web Sample Extension

[![Build Status](https://dev.azure.com/ms/azure-devops-extension-sample/_apis/build/status/Microsoft.azure-devops-extension-sample)](https://dev.azure.com/ms/azure-devops-extension-sample/_build/latest?definitionId=14)

This repository generates an [Azure DevOps extension](https://docs.microsoft.com/en-us/azure/devops/extend/overview?view=vsts) containing a number of different contributions of various types.

## Dependencies
Expand Down Expand Up @@ -38,14 +36,82 @@ You can also clone the sample project and change the `publisher` property in `az

# Samples

Individual sample contributions are self-contained folders under `./src/Samples`. Within each sample you will find:
Individual sample contributions are self-contained folders under `./src/Samples`. These samples will match those contribution points [as documented](https://learn.microsoft.com/en-us/azure/devops/extend/reference/targets/overview?view=azure-devops). Within each sample you will find:

1. `{SampleName}.json` - describes the contribution objects being added to Azure DevOps
2. `{SampleName}.html` - page which is rendered within an iframe on the appropriate Azure DevOps page or pages. It may be visible UI (such as a Hub) or a background iframe (such as a Menu action handler). This will include a sample reference for `{SampleName}.js`, and for visible frames it will contain a single `<div>` element with an id of `root`.
3. `{SampleName}.ts(x)` - Root script that is run when the frame is loaded. A webpack entry is added for this file which will generate a single `js` file with this content and all its dependencies.
4. `{SampleName}.scss` - optional sass file containing the styles (CSS) for the UI
5. Additional ts/tsx files - For samples that are too big for one file, the code will be broken up appropriately

## Hubs and hub groups

Hubs and hub groups are the primary navigation elements in Azure DevOps. Files, Releases, Backlogs, and Queries are examples of hubs. A hub belongs to a hub group. The Files hub, for example, belongs to the project-level Azure Repos hub group. Hub groups can exist at the organization or collection level or the project level. Most extensions contribute to the project level.

Here are samples for the [most common hub contributions](https://learn.microsoft.com/en-us/azure/devops/extend/reference/targets/overview?toc=%2Fazure%2Fdevops%2Fmarketplace-extensibility%2Ftoc.json&view=azure-devops#hubs-and-hub-groups):

- Azure Boards - [work-hub-group](src/Samples/work-hub-group)
- Azure Repos - [code-hub-group](src/Samples/code-hub-group)
- Azure Pipelines - [build-release-hub-group](src/Samples/build-release-hub-group)
- Azure Test Plans - [test-hub-group](src/Samples/test-hub-group)
- Project Settings - [project-admin-hub-group](src/Samples/project-admin-hub-group)
- Organization Settings - [collection-admin-hub-group](src/Samples/collection-admin-hub-group)

## Azure Boards menu and toolbar

- Work item query menu - [work-item-query-menu](src/Samples/work-item-query-menu)
- Work item query results toolbar menu - [work-item-query-results-toolbar-menu](src/Samples/work-item-query-results-toolbar-menu)
- Work item query results menu item - [query-result-work-item-menu](src/Samples/query-result-work-item-menu)
- Work item query results tab - [query-tabs](src/Samples/query-tabs)
- Work item for context menu - [work-item-toolbar-menu](src/Samples/work-item-toolbar-menu)
- Backlog item menu - [backlog-item-menu](src/Samples/backlog-item-menu)
- Sprint board pivot filter menu - [sprint-board-pivot-filter-menu](src/Samples/sprint-board-pivot-filter-menu)
- Board pivot filter menu - [backlog-board-pivot-filter-menu](src/Samples/backlog-board-pivot-filter-menu)
- Card menu - [backlog-board-card-item-menu](src/Samples/backlog-board-card-item-menu)
- Product backlog tab - [product-backlog-tabs](src/Samples/product-backlog-tabs)
- Iteration backlog tab - [iteration-backlog-tabs](src/Samples/iteration-backlog-tabs)
- Portfolio backlog pane - [portfolio-backlog-toolpane](src/Samples/backlog-toolpane)
- Product backlog pane - [requirement-backlog-toolpane](src/Samples/backlog-toolpane)
- Iteration backlog pane - [iteration-backlog-toolpane](src/Samples/backlog-toolpane)

## Azure Pipelines menu and toolbar

- Completed build menu - [completed-build-menu](src/Samples/completed-build-menu)
- Build definitions menu - [build-definitions-menu](src/Samples/build-definitions-menu)
- Test results toolbar action - [test-results-actions-menu](src/Samples/test-results-actions-menu)
- Test result details tab - [test-result-details-tab-items](src/Samples/test-result-details-tab-items)
- Release pipeline explorer context menu - [release-definition-explorer-context-menu](src/Samples/release-definition-explorer-context-menu)
- Pipeline details view, header button - [pipelines-header-menu](src/Samples/pipelines-header-menu)
- Pipeline details view, folder context menu - [pipelines-folder-menu](src/Samples/pipelines-folder-menu)

## Azure Repos menu and toolbar

- Source item (grid) menu - [source-grid-item-menu](src/Samples/source-grid-item-menu)
- Source item (tree) menu - [source-tree-item-menu](src/Samples/source-tree-item-menu)
- Source item (grid and tree) menu - [source-item-menu](src/Samples/source-item-menu)
- Git branches tree menu - [git-branches-tree-menu](src/Samples/git-branches-tree-menu)
- Git pull request actions menu - [pull-request-action-menu](src/Samples/pull-request-action-menu)
- Git pull request details tabs - [pr-tabs](src/Samples/pr-tabs)
- Git commit listing menu - [git-commit-list-menu](src/Samples/git-commit-list-menu)
- Git commit detail menu - [git-commit-details-menu](src/Samples/git-commit-details-menu)

## Azure Test Plans menu and toolbar

- Test run grid menu - [test-run-grid-menu](src/Samples/test-run-grid-menu)
- Test plan suites tree menu - [test-plans-suites-context](src/Samples/test-plans-suites-context)
- Test plan hub pivot tab - [test-plan-pivot-tabs](src/Samples/test-plan-pivot-tabs)

## Dashboard widgets

This sample adds a widget extension using the `IConfigurableWidget` interface to demonstrate how to customize your dashboards to show status, progress, or trends. It includes an associated widget configuration using the `IWidgetConfiguration` interface so users can customize the experience.

- Widget - [widget-catalog](src/Samples/widget-catalog)
- Widget configuration - [widget-configuration](src/Samples/widget-configuration)

# Examples

Examples are self contained samples that demonstrate how to use the Azure DevOps SDK to interact with the Azure DevOps REST APIs. They are located in the `./src/Examples` folder. The examples are not be included when building the extension.

## BreadcrumbService

This sample adds a breadcrumb service which adds a "Sample Breadcrumb Item" global breadcrumb item to the sample hub. Visit the "Sample Hub" in the `Pipelines` hub group to see this item.
Expand Down
35 changes: 35 additions & 0 deletions azure-devops-extension-dev.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
{
"manifestVersion": 1,
"id": "samples-dev",
"publisher": "ms-samples",
"version": "1.0.396",
"name": "Extension Sample [DEV]",
"description": "Azure DevOps extension sample. For development purposes only.",
"categories": [
"Azure Pipelines"
],
"targets": [
{
"id": "Microsoft.VisualStudio.Services"
}
],
"icons": {
"default": "logo.png"
},
"content": {
"details": {
"path": "overview.md"
}
},
"files": [
{
"path": "static",
"addressable": true
},
{
"path": "dist",
"addressable": true
}
],
"baseUri": "https://localhost:3000"
}
4 changes: 2 additions & 2 deletions azure-devops-extension.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"manifestVersion": 1,
"id": "samples",
"publisher": "ms-samples",
"version": "1.0.391",
"publisher": "",
"version": "1.0.464",
"name": "Extension Sample",
"description": "Azure DevOps extension sample",
"categories": [
Expand Down
Loading