The supplied extension definition isn't valid: 'Uploaded extension package is missing an 'overview.md' file which is a mandatory details asset. Try again after adding the file.'.

Question

The supplied extension definition isn't valid: 'Uploaded extension package is missing an 'overview.md' file which is a mandatory details asset. Try again after adding the file.'.

Rajneesh Sheth 0

Microsoft Windows [Version 10.0.26100.3775]

D:\testextension\test\workitem-extension-public-vsix-ready>npm install

npm warn deprecated inflight@1.0.6: This module is not supported, and leaks memory. Do not use it. Check out lru-cache if you want a good and tested way to coalesce async requests by a key value, which is much more comprehensive and powerful.

npm warn deprecated rimraf@3.0.2: Rimraf versions prior to v4 are no longer supported

npm warn deprecated glob@7.2.3: Glob versions prior to v9 are no longer supported

added 481 packages, and audited 482 packages in 27s

65 packages are looking for funding

run npm fund for details

found 0 vulnerabilities

D:\testextension\test\workitem-extension-public-vsix-ready>npm ruin build

Unknown command: "ruin"

To see a list of supported npm commands, run:

npm help

D:\testextension\test\workitem-extension-public-vsix-ready>npm run build

workitem-extension@1.0.0 build

webpack --mode production

asset bundle.js 137 KiB [emitted] [minimized] (name: main) 1 related asset

asset index.html 257 bytes [emitted]

modules by path ./node_modules/react-dom/ 131 KiB

./node_modules/react-dom/client.js 619 bytes [built] [code generated]

./node_modules/react-dom/index.js 1.33 KiB [built] [code generated]

./node_modules/react-dom/cjs/react-dom.production.min.js 129 KiB [built] [code generated]

modules by path ./node_modules/react/ 6.95 KiB

./node_modules/react/index.js 190 bytes [built] [code generated]

./node_modules/react/cjs/react.production.min.js 6.77 KiB [built] [code generated]

modules by path ./node_modules/scheduler/ 4.33 KiB

./node_modules/scheduler/index.js 198 bytes [built] [code generated]

./node_modules/scheduler/cjs/scheduler.production.min.js 4.14 KiB [built] [code generated]

./src/index.js 940 bytes [built] [code generated]

webpack 5.99.6 compiled successfully in 3018 ms

D:\testextension\test\workitem-extension-public-vsix-ready>tfx extension create --manifest-globs vss-extension.json

TFS Cross Platform Command Line Interface v0.21.1

Copyright Microsoft Corporation

=== Completed operation: create extension ===

VSIX: D:\testextension\test\workitem-extension-public-vsix-ready\RajneeshSheth.workitem-extension-1.0.0.vsix
Extension ID: workitem-extension
Extension Version: 1.0.0
Publisher: RajneeshSheth

D:\testextension\test\workitem-extension-public-vsix-ready>tfx extension publish --manifest-globs vss-extension.json --publisher RajneeshSheth --token 832bV50XDljN5E3mbYciip75AVAocpqm64c2xQt0k1y4mfI6wPWcJQQJ99BCACAAAAAq259BAAASAZDO4LM4

TFS Cross Platform Command Line Interface v0.21.1

Copyright Microsoft Corporation

Checking if this extension is already published

It isn't, create a new extension.

error: The supplied extension definition isn't valid: 'Uploaded extension package is missing an 'overview.md' file which is a mandatory details asset. Try again after adding the file.'.

D:\testextension\test\workitem-extension-public-vsix-ready>

Rajneesh Sheth 0 Reputation points

2025-04-23T15:24:24.55+00:00

while publishing a simple extension with only two fields facing this issue , tried 3 other ui packages and facing the same issue , ensured overview.md file is present in vsix file and is in utf 8 format
Sirra Sneha 550 Reputation points Microsoft External Staff Moderator

2025-04-24T06:26:57.7233333+00:00
Hi @Rajneesh Sheth ,

The error you're seeing typically means that Azure DevOps can't find or read the overview.md file

To resolve the issue,

Make sure overview.md is referenced in vss-extension.json

sample vs-extension.json

"overview": "overview.md", "files": [ { "path": "dist", "addressable": true }, { "path": "overview.md", "addressable": false } ]

Ensure overview.md is in the root directory

Sometimes the file isn't included due to caching, so run the below command,

tfx extension create --manifest-globs vss-extension.json --override "{ \"version\": \"1.0.1\" }"
Rajneesh Sheth 0 Reputation points

2025-04-24T08:54:40.2233333+00:00

{ "manifestVersion": 1, "id": "workitem-extension", "name": "Work Item Extension", "version": "1.0.0", "publisher": "RajneeshSheth", "description": "A simple public Azure DevOps extension with a React-based two-column UI.", "categories": [ "Azure Boards" ], "galleryFlags": [ "Public" ], "targets": [ { "id": "Microsoft.VisualStudio.Services" } ], "files": [ { "path": "dist", "addressable": true }, { "path": "overview.md", "addressable": true } ], "contributions": [ { "id": "workitem-panel", "type": "ms.vss-web.hub", "targets": ["ms.vss-web.project-hub"], "properties": { "name": "Work Item Viewer", "uri": "dist/index.html" } } ] }
Rajneesh Sheth 0 Reputation points

2025-04-24T08:55:41.13+00:00

extension error.pdf
Sirra Sneha 550 Reputation points Microsoft External Staff Moderator

2025-04-28T07:47:49.95+00:00
Hi @Rajneesh Sheth ,

It seems you've already taken the correct steps, including referencing overview.md in the vss-extension.json and ensuring it’s in the root directory. A couple of additional things to try:

Double-check that overview.md is set as non-addressable in the manifest like this:
"files": [ { "path": "dist", "addressable": true }, { "path": "overview.md", "addressable": false }

Clear any potential caching issues by running:
tfx extension create --manifest-globs vss-extension.json --override "{ \"version\": \"1.0.1\" }"
Sirra Sneha 550 Reputation points Microsoft External Staff Moderator

2025-04-29T06:35:09.66+00:00

Hi @Rajneesh Sheth ,

Just checking in to see if above information was helpful. If you have any further updates on this issue, please feel free to post back.
Rajneesh Sheth 0 Reputation points

2025-04-29T08:59:20.9266667+00:00

hi ,

cache is cleared and checking with MS Support team for further actions , i will keep you posted as i am able to progress.

Best Regards

Rajneesh
Sirra Sneha 550 Reputation points Microsoft External Staff Moderator

2025-04-30T06:37:08.95+00:00

Hi @Rajneesh Sheth ,

Thanks for the update. please do keep me posted on any progress or findings from the support team. Happy to assist further if needed.
Sirra Sneha 550 Reputation points Microsoft External Staff Moderator

2025-05-05T04:23:51.83+00:00

Hi @Rajneesh Sheth ,

We haven't heard any response from you,If you have any further updates on this issue, please feel free to post back.
Sirra Sneha 550 Reputation points Microsoft External Staff Moderator

2025-05-07T05:43:35.89+00:00

Hi @Rajneesh Sheth ,

Just checking in to see if above information was helpful. If you have any further updates on this issue, please feel free to post back.

1 answer

Your answer

Rajneesh Sheth 0 Reputation points

2025-04-23T15:24:24.55+00:00

while publishing a simple extension with only two fields facing this issue , tried 3 other ui packages and facing the same issue , ensured overview.md file is present in vsix file and is in utf 8 format
Sirra Sneha 550 Reputation points Microsoft External Staff Moderator

2025-04-24T06:26:57.7233333+00:00

Hi @Rajneesh Sheth ,

The error you're seeing typically means that Azure DevOps can't find or read the overview.md file

To resolve the issue,

Make sure overview.md is referenced in vss-extension.json

sample vs-extension.json

"overview": "overview.md", "files": [ { "path": "dist", "addressable": true }, { "path": "overview.md", "addressable": false } ]

Ensure overview.md is in the root directory

Sometimes the file isn't included due to caching, so run the below command,

tfx extension create --manifest-globs vss-extension.json --override "{ \"version\": \"1.0.1\" }"
Rajneesh Sheth 0 Reputation points

2025-04-24T08:54:40.2233333+00:00

{ "manifestVersion": 1, "id": "workitem-extension", "name": "Work Item Extension", "version": "1.0.0", "publisher": "RajneeshSheth", "description": "A simple public Azure DevOps extension with a React-based two-column UI.", "categories": [ "Azure Boards" ], "galleryFlags": [ "Public" ], "targets": [ { "id": "Microsoft.VisualStudio.Services" } ], "files": [ { "path": "dist", "addressable": true }, { "path": "overview.md", "addressable": true } ], "contributions": [ { "id": "workitem-panel", "type": "ms.vss-web.hub", "targets": ["ms.vss-web.project-hub"], "properties": { "name": "Work Item Viewer", "uri": "dist/index.html" } } ] }
Rajneesh Sheth 0 Reputation points

2025-04-24T08:55:41.13+00:00

extension error.pdf
Sirra Sneha 550 Reputation points Microsoft External Staff Moderator

2025-04-28T07:47:49.95+00:00

Hi @Rajneesh Sheth ,

It seems you've already taken the correct steps, including referencing overview.md in the vss-extension.json and ensuring it’s in the root directory. A couple of additional things to try:

Double-check that overview.md is set as non-addressable in the manifest like this:
"files": [ { "path": "dist", "addressable": true }, { "path": "overview.md", "addressable": false }

Clear any potential caching issues by running:
tfx extension create --manifest-globs vss-extension.json --override "{ \"version\": \"1.0.1\" }"
Sirra Sneha 550 Reputation points Microsoft External Staff Moderator

2025-04-29T06:35:09.66+00:00

Hi @Rajneesh Sheth ,

Just checking in to see if above information was helpful. If you have any further updates on this issue, please feel free to post back.
Rajneesh Sheth 0 Reputation points

2025-04-29T08:59:20.9266667+00:00

hi ,

cache is cleared and checking with MS Support team for further actions , i will keep you posted as i am able to progress.

Best Regards

Rajneesh
Sirra Sneha 550 Reputation points Microsoft External Staff Moderator

2025-04-30T06:37:08.95+00:00

Hi @Rajneesh Sheth ,

Thanks for the update. please do keep me posted on any progress or findings from the support team. Happy to assist further if needed.
Sirra Sneha 550 Reputation points Microsoft External Staff Moderator

2025-05-05T04:23:51.83+00:00

Hi @Rajneesh Sheth ,

We haven't heard any response from you,If you have any further updates on this issue, please feel free to post back.
Sirra Sneha 550 Reputation points Microsoft External Staff Moderator

2025-05-07T05:43:35.89+00:00

Hi @Rajneesh Sheth ,

Just checking in to see if above information was helpful. If you have any further updates on this issue, please feel free to post back.

Answer 1

Rajneesh Sheth 0

hi ,

with creating a new vss.extension.json i was able to publish the extension i will check this for some more extensions and will provide details if i face any issues

Sirra Sneha 550 Reputation points Microsoft External Staff Moderator

2025-05-08T11:44:53.4966667+00:00

Hi @Rajneesh Sheth ,

Thanks for the update. Feel free to share any updates from the support team. Happy to assist further if needed.
Sirra Sneha 550 Reputation points Microsoft External Staff Moderator

2025-05-14T11:08:12.78+00:00

Hi @Rajneesh Sheth ,

Following up to check if the issue is resolved or if you need any further assistance. Let me know how it's going!

Share via

The supplied extension definition isn't valid: 'Uploaded extension package is missing an 'overview.md' file which is a mandatory details asset. Try again after adding the file.'.

1 answer

Your answer