[Excel] (hello world) Add unified manifest by alison-mk · Pull Request #979 · OfficeDev/Office-Add-in-samples

alison-mk · 2025-06-04T05:00:39Z

Q	A
Bug fix?	no
New feature?	no
New sample?	no
Related issues?	none

What's in this Pull Request?

Converts to the unified manifest for Microsoft 365.

…ub.com/OfficeDev/Office-Add-in-samples into alison-mk-unified-manifest-hello-world

Copilot

Pull request overview

This PR converts the Excel Hello World sample from XML manifests to the unified manifest for Microsoft 365 (JSON) and adds the supporting webpack + npm tooling to build/sideload it.

Changes:

Replaces manifest.xml / manifest-localhost.xml with a unified manifest.json (v1.25).
Adds webpack build configuration to generate a production-ready dist/manifest.json and copy assets.
Updates the README to reflect new prerequisites and run instructions; adds sample-local .gitignore and a new package.json.

Reviewed changes

Copilot reviewed 7 out of 8 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
Samples/hello-world/excel-hello-world/webpack.config.js	Adds webpack build/dev-server config and manifest URL rewriting for prod builds.
Samples/hello-world/excel-hello-world/README.md	Updates documentation for unified manifest usage and new run flows.
Samples/hello-world/excel-hello-world/package.json	Introduces scripts and dependencies for building, debugging, and validating the unified manifest.
Samples/hello-world/excel-hello-world/manifest.json	Adds the unified manifest (v1.25) describing the add-in commands/runtime.
Samples/hello-world/excel-hello-world/.gitignore	Adds local ignores for node/TeamsFx/build artifacts.
Samples/hello-world/excel-hello-world/manifest.xml	Removes legacy XML manifest (GitHub-hosted variant).
Samples/hello-world/excel-hello-world/manifest-localhost.xml	Removes legacy XML manifest (localhost variant).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-31T21:55:46Z

Samples/hello-world/excel-hello-world/manifest-configurations/unified/webpack.config.js

+            from: "manifest*.json",
+            to: "[name]" + "[ext]",
+            transform(content) {
+              if (dev) {
+                return content;
+              } else {
+                return content.toString().replace(new RegExp(urlDev, "g"), urlProd);
+              }


The production manifest URL replacement only replaces the exact urlDev string (https://localhost:3000/). In manifest.json, validDomains uses https://localhost:3000 (no trailing slash), so the dev host will remain in dist/manifest.json after a production build. This can cause the prod manifest to reference officedev.github.io URLs while still only allowing localhost in validDomains. Update the transform to also replace the no-trailing-slash form (or replace just the origin/host in a URL-aware way) so validDomains and all URLs are updated consistently.

Samples/hello-world/excel-hello-world/manifest.json

Samples/hello-world/excel-hello-world/README.md

Samples/hello-world/excel-hello-world/package.json

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Rick-Kirkham · 2026-04-03T16:59:52Z

Samples/hello-world/excel-hello-world/README.md

-Choose the **Hello world** button on the **Home** tab to display the task pane of the add-in. Choose the **Say hello** button to insert "Hello world!" in cell A1.
+When you're finished working with the add-in, close Excel, and then in the window where you ran the three npm commands, run `npm run stop:prod`.

 ## Run the sample on Excel on Windows or Mac


Delete this section. The package.json and unified manifest are configured to automatically sideload on desktop anyway. This sample doesn't give the option of testing on the web.

@Rick-Kirkham Thank you for the review! I adjusted the PR to retain the XML manifest options, so that the sample is still cross-platform (unified manifest is only supported on Windows). Could you review again?

Rick-Kirkham · 2026-04-03T17:01:09Z

Samples/hello-world/excel-hello-world/README.md

 - [Sideload Office Add-ins on Mac for testing](https://learn.microsoft.com/office/dev/add-ins/testing/sideload-an-office-add-in-on-mac)
 - [Sideload Office Add-ins on iPad for testing](https://learn.microsoft.com/office/dev/add-ins/testing/sideload-an-office-add-in-on-ipad)

 ## Configure a localhost web server and run the sample from localhost


Delete this section. There's only one unified manifest and it uses local host, not the github hosting, so users are taking this "option" already.

ElizabethSamuel-MSFT · 2026-04-03T17:23:29Z

Samples/hello-world/excel-hello-world/README.md

 ## Applies to

- Excel on Windows, Mac, and in a browser.
+- Excel on Windows, Mac, and the web.


I thought we were keeping the .xml manifest because unified manifest doesn't currently support Mac?

If this sample remains without XML, then you may need to remove Mac from the support list for now

Thank you! I adjusted the PR to retain the XML manifest.

Rick-Kirkham

Approving with an exception that will reduce the steps for the developer.

Samples/hello-world/excel-hello-world/README.md

Co-authored-by: Rick Kirkham <Rick-Kirkham@users.noreply.github.com>

[Excel] (hello world) Add unified manifest

a74b819

Rick-Kirkham added the Do Not Merge This PR has additional work or review required before it is ready to merge. label Jun 11, 2025

alison-mk added 10 commits June 11, 2025 18:50

Add package.json

e468387

Update readme and add gitignore

cad74ce

Merge branch 'alison-mk-unified-manifest-hello-world' of https://gith…

4fa578c

…ub.com/OfficeDev/Office-Add-in-samples into alison-mk-unified-manifest-hello-world

Add webpack.config.js

2641271

Merge branch 'alison-mk-unified-manifest-hello-world' of https://gith…

7964b9d

…ub.com/OfficeDev/Office-Add-in-samples into alison-mk-unified-manifest-hello-world

Add package-lock.json, update webpack.config.js

1223cf5

Remove old manifests, edit package.json

c0bf328

Update manifest.json

5497a92

Update readme.md

861a95f

Switch to unified manifest v1.25

67d4177

alison-mk marked this pull request as ready for review February 6, 2026 03:19

alison-mk requested a review from Copilot March 31, 2026 21:51

Copilot started reviewing on behalf of alison-mk March 31, 2026 21:52 View session

Copilot AI reviewed Mar 31, 2026

View reviewed changes

alison-mk and others added 3 commits March 31, 2026 14:59

Merge branch 'main' into alison-mk-unified-manifest-hello-world

56cc479

Apply suggestions from code review

ea5de39

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Minor readme tweaks

9366085

alison-mk removed the Do Not Merge This PR has additional work or review required before it is ready to merge. label Apr 2, 2026

alison-mk requested a review from Rick-Kirkham April 2, 2026 22:10

Remove node and npm version restriction from package.json

52ea423

Rick-Kirkham requested changes Apr 3, 2026

View reviewed changes

ElizabethSamuel-MSFT reviewed Apr 3, 2026

View reviewed changes

alison-mk added 5 commits April 3, 2026 13:03

Adjust to retain xml manifest, so that sample is supported on Mac

c771781

Make sure manifest-localhost actually uses localhost

c143215

Grammar review of readme.md

2e28cb3

Update readme.md steps based on new UX

635e7f0

Slight readme.md adjustment

6629d2e

alison-mk requested a review from Rick-Kirkham April 7, 2026 01:15

Rick-Kirkham approved these changes Apr 7, 2026

View reviewed changes

Samples/hello-world/excel-hello-world/README.md Outdated Show resolved Hide resolved

Samples/hello-world/excel-hello-world/README.md Outdated Show resolved Hide resolved

Apply suggestions from code review

cb16013

Co-authored-by: Rick Kirkham <Rick-Kirkham@users.noreply.github.com>

alison-mk merged commit 9b4476f into main Apr 7, 2026
1 check passed

alison-mk deleted the alison-mk-unified-manifest-hello-world branch April 7, 2026 18:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Excel] (hello world) Add unified manifest#979

[Excel] (hello world) Add unified manifest#979
alison-mk merged 21 commits intomainfrom
alison-mk-unified-manifest-hello-world

alison-mk commented Jun 4, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Mar 31, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Rick-Kirkham Apr 3, 2026

Uh oh!

alison-mk Apr 7, 2026

Uh oh!

Rick-Kirkham Apr 3, 2026

Uh oh!

ElizabethSamuel-MSFT Apr 3, 2026

Uh oh!

ElizabethSamuel-MSFT Apr 3, 2026

Uh oh!

alison-mk Apr 7, 2026

Uh oh!

Rick-Kirkham left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

alison-mk commented Jun 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What's in this Pull Request?

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Mar 31, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Rick-Kirkham Apr 3, 2026

Choose a reason for hiding this comment

Uh oh!

alison-mk Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

Rick-Kirkham Apr 3, 2026

Choose a reason for hiding this comment

Uh oh!

ElizabethSamuel-MSFT Apr 3, 2026

Choose a reason for hiding this comment

Uh oh!

ElizabethSamuel-MSFT Apr 3, 2026

Choose a reason for hiding this comment

Uh oh!

alison-mk Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

Rick-Kirkham left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

alison-mk commented Jun 4, 2025 •

edited

Loading