Staging to main (#4201)

fixes #[issue number] 
<!-- Link to relevant issue (for ex: "fixes #1234") which will
automatically close the issue once the PR is merged -->

## PR Type
<!-- Please uncomment one ore more that apply to this PR -->

<!-- - Bugfix -->
<!-- - Feature -->
<!-- - Code style update (formatting) -->
<!-- - Refactoring (no functional changes, no api changes) -->
<!-- - Build or CI related changes -->
<!-- - Documentation content changes -->
<!-- - Sample app changes -->
<!-- - Other... Please describe: -->


## Describe the current behavior?
<!-- Please describe the current behavior that is being modified or link
to a relevant issue. -->


## Describe the new behavior?


## PR Checklist

- [ ] Test: run `npm run test` and ensure that all tests pass
- [ ] Target main branch (or an appropriate release branch if
appropriate for a bug fix)
- [ ] Ensure that your contribution follows [standard accessibility
guidelines](https://docs.microsoft.com/en-us/microsoft-edge/accessibility/design).
Use tools like https://webhint.io/ to validate your changes.


## Additional Information

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: Jaylyn Barbee <[email protected]>
Co-authored-by: Jaylyn Barbee <[email protected]>
Co-authored-by: Nikola Metulev <[email protected]>
Co-authored-by: Gleb Khmyznikov <[email protected]>
Co-authored-by: Mara'ah Lee <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Adolf Daniel <[email protected]>
Co-authored-by: Justin Willis (HE / HIM) <[email protected]>
Co-authored-by: Zach Teutsch <[email protected]>
Co-authored-by: Beth Pan <[email protected]>
Co-authored-by: vipul-bhojwani <[email protected]>
Co-authored-by: Amrutha Srinivasan <[email protected]>
Co-authored-by: Federico Navarrete <[email protected]>
Co-authored-by: Toby Liu <[email protected]>
Co-authored-by: microsoft-github-policy-service[bot] <77245923+microsoft-github-policy-service[bot]@users.noreply.github.com>
Co-authored-by: Amrutha Srinivasan <[email protected]>

.github/workflows/docs-github-pages.yml

@@ -0,0 +1,49 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy static content to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main"]
+    paths: ["docs/**"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Single deploy job since we're just deploying
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '16.x'
+      - name: Setup Docs
+        run: cd docs/ && npm run setup
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
+        with:
+          # Upload entire repository
+          path: '.'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

.gitignore

@@ -5,4 +5,5 @@ dist
 build
 coverage
 sl-icons/
-types/
+types/
+docs/**/_sidebar.md

apps/pwabuilder/src/script/pages/app-report.api.ts

@@ -1,4 +1,5 @@
 import { env } from '../utils/environment';
+import { getHeaders } from '../utils/platformTrackingHeaders';
 
 export type ReportAudit = {
 	audits: {
@@ -71,7 +72,10 @@ export async function Report(
 	const fetchReport = await fetch(
 		`${
 			env.api
-		}/Report?site=${encodeURIComponent(url)}&desktop=true`
+		}/Report?site=${encodeURIComponent(url)}&desktop=true`,
+		{
+			headers: new Headers(getHeaders())
+		}
 	);
 
 	if (!fetchReport?.ok) {

docs/package.json

@@ -3,15 +3,18 @@
   "private": true,
   "version": "0.0.1",
   "scripts": {
-    "start": "docsify serve",
+    "start": "npm run setup && docsify serve",
     "preinstall": "node ../scripts/setupDeps.js && npm run copy-analytics",
-    "copy-analytics": "cpx \"..\\libraries\\site-analytics\\dist\\index.js\" \"public\\analytics\""
+    "copy-analytics": "cpx \"..\\libraries\\site-analytics\\dist\\index.js\" \"public\\analytics\"",
+    "clean": "rm -rf dist",
+    "setup": "npm run clean && tsc && node dist/setup.js"
   },
   "dependencies": {
     "@pwabuilder/site-analytics": "file:../../libraries/site-analytics"
   },
   "devDependencies": {
-    "docsify-cli": "^4.4.4",
-    "cpx": "^1.5.0"
+    "@types/node": "^20.4.2",
+    "cpx": "^1.5.0",
+    "docsify-cli": "^4.4.4"
   }
 }