From 5be7144dc307c8db35f765687d7239a340fd1ad4 Mon Sep 17 00:00:00 2001 From: wandyezj Date: Sun, 7 Jul 2024 14:02:08 -0700 Subject: [PATCH] Sideloading instructions --- .github/workflows/build.yml | 4 ++-- .vscode/cspell.json | 2 +- .vscode/extensions.json | 3 +-- README.md | 7 +++++-- docs/setup.md | 2 +- docs/sideload.md | 28 ++++++++++++++++++++++++++++ docs/sideloading.md | 17 ----------------- 7 files changed, 38 insertions(+), 25 deletions(-) create mode 100644 docs/sideload.md delete mode 100644 docs/sideloading.md diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index d1cf52e..4f27ced 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -70,11 +70,11 @@ jobs: path: dist/ ## end to end tests - - name: Install Playwright Browsers + - name: Playwright Install if: inputs.test run: npm run playwright-install - - name: Run Playwright tests + - name: Playwright Test if: inputs.test run: npm run playwright-test env: diff --git a/.vscode/cspell.json b/.vscode/cspell.json index fdc925c..282808c 100644 --- a/.vscode/cspell.json +++ b/.vscode/cspell.json @@ -26,7 +26,7 @@ "SETCOLOR", "SHOWTASKPANE", "Sideload", - "Sideloading", + "sideloading", "taskpane", "Taskpanes", "telemetryservice", diff --git a/.vscode/extensions.json b/.vscode/extensions.json index 22a877c..ff9ba7d 100644 --- a/.vscode/extensions.json +++ b/.vscode/extensions.json @@ -7,7 +7,6 @@ "ms-playwright.playwright", "bierner.github-markdown-preview", "streetsidesoftware.code-spell-checker", - "vscode-icons-team.vscode-icons", - "redhat.vscode-xml" + "vscode-icons-team.vscode-icons" ] } diff --git a/README.md b/README.md index 736fe28..cedc9e0 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,12 @@ ![Logo](./assets/icon-80.png) -Get the [Build Add-In](https://appsource.microsoft.com/en-us/product/office/WA200006798). +Get the Build Add-In from Microsoft AppSource: -Get the [Build for Outlook Add-In](https://appsource.microsoft.com/en-us/product/office/WA200006932). +- Get for [Word, Excel, and PowerPoint](https://appsource.microsoft.com/en-us/product/office/WA200006798). +- Get for [Outlook](https://appsource.microsoft.com/en-us/product/office/WA200006932). + +Alternatively, [sideload the manifests](https://github.com/wandyezj/build-add-in/blob/main/docs/sideload.md). [Tutorial](https://github.com/wandyezj/build-add-in/blob/main/docs/tutorial.md) diff --git a/docs/setup.md b/docs/setup.md index b4c3595..a1def92 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -37,7 +37,7 @@ Other manifest files are generated from the base files using: > npm run manifest -Once you have updates the manifests, test them via [sideloading](./sideloading.md). +Once you have updates the manifests, test them via [sideloading](./sideload.md). ## Test diff --git a/docs/sideload.md b/docs/sideload.md new file mode 100644 index 0000000..e38515f --- /dev/null +++ b/docs/sideload.md @@ -0,0 +1,28 @@ +# Sideload + +[Sideload Add-Ins for testing](https://learn.microsoft.com/en-us/office/dev/add-ins/testing/sideload-office-add-ins-for-testing) + +For outlook web use: +https://outlook.live.com/mail/0/inclientstore + +## Production + +Download the production manifest: + +- Get for [Word, Excel, and PowerPoint](https://store.office.com/app/download?assetid=WA200006798&cmu=en-US). +- Get for [Outlook](https://store.office.com/app/download?assetid=WA200006932&cmu=en-US). + +If you are using a managed account, there is an IT setting that can disable loading from the store and a setting that can disable sideloading. If you can't access the store you might still be able to sideload. + +## Testing + +### Setup manifest share + +As administrator run: +> .\scripts\create-manifest-share.cmd + +### Copy over manifests + +This copies over the latest manifests to the manifest share. + +> npm run share \ No newline at end of file diff --git a/docs/sideloading.md b/docs/sideloading.md deleted file mode 100644 index dfbc286..0000000 --- a/docs/sideloading.md +++ /dev/null @@ -1,17 +0,0 @@ -# Sideloading - -[Sideload Add-Ins for testing](https://learn.microsoft.com/en-us/office/dev/add-ins/testing/sideload-office-add-ins-for-testing) - -For outlook web use: -https://outlook.live.com/mail/0/inclientstore - -## Setup manifest share - -As administrator run: -> .\scripts\create-manifest-share.cmd - -## Copy over manifests - -This copies over the latest manifests to the manifest share. - -> npm run share \ No newline at end of file