@salesforcedevs/sfdocs-e2e 1.0.0-alpha.0 → 1.0.0-alpha.11

package/README.md

@@ -43,6 +43,11 @@ Tests are organised into three suites, each targeting a different surface:
 - Google Chrome installed (ChromeDriver version is auto-detected from your local Chrome installation)
 - A running SFDocs portal at the target base URL
 
+The `static-portal` suite excludes the following tests that are not applicable to static builds:
+
+- `docs.api.test.ts` and `docs.test.ts` — landing pages that don't exist in static builds
+- Footer tests (`should display footer`) — footer component is not available in static builds
+
 ### Run against the static portal (default)
 
 ```bash
@@ -154,14 +159,21 @@ Publish a new version when:
 
 Always validate with an alpha release first, then promote to stable.
 
+The e2e package is marked `"private": true` so it is automatically skipped during the monorepo's standard `yarn release` workflow. Two convenience scripts handle temporarily removing the private flag, publishing, and restoring it:
+
+| Script              | Command                            | Description                        |
+| ------------------- | ---------------------------------- | ---------------------------------- |
+| `release:alpha:e2e` | `yarn release:alpha:e2e <version>` | Publish with the `alpha` dist-tag  |
+| `release:e2e`       | `yarn release:e2e <version>`       | Publish with the `latest` dist-tag |
+
 **1. Publish an alpha (for testing)**
 
 ```bash
 cd packages/e2e
-yarn publish --tag alpha --new-version 1.0.0-alpha.0
+yarn release:alpha:e2e 1.0.0-alpha.0
 ```
 
-The `alpha` dist-tag means `npm install @salesforcedevs/sfdocs-e2e` will **not** resolve this version by default — consumers must opt in explicitly:
+The `alpha` dist-tag means `yarn add @salesforcedevs/sfdocs-e2e` will **not** resolve this version by default — consumers must opt in explicitly:
 
 ```bash
 # Install latest alpha
@@ -176,18 +188,21 @@ Iterate on alphas as needed (`1.0.0-alpha.1`, `1.0.0-alpha.2`, ...) until the re
 **2. Promote to stable**
 
 ```bash
-yarn publish --tag latest --new-version 1.0.0
+cd packages/e2e
+yarn release:e2e 1.0.0
 ```
 
 **3. Future releases — bump and publish**
 
 ```bash
+cd packages/e2e
+
 # Bug fix
-yarn publish --tag latest --new-version 1.0.1
+yarn release:e2e 1.0.1
 
 # New feature
-yarn publish --tag latest --new-version 1.1.0
+yarn release:e2e 1.1.0
 
 # Breaking change
-yarn publish --tag latest --new-version 2.0.0
+yarn release:e2e 2.0.0
 ```

package/bin/publish.sh

@@ -0,0 +1,31 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+VERSION="${1:?Usage: publish.sh <version> [--tag <tag>]}"
+shift
+
+cp package.json .package.json.bak
+
+cleanup() {
+  mv .package.json.bak package.json
+  node -e "
+    var p = require('./package.json');
+    p.version = '$VERSION';
+    require('fs').writeFileSync('package.json', JSON.stringify(p, null, 2) + '\n');
+  "
+  git add package.json
+  git commit --amend --no-edit
+}
+trap cleanup EXIT
+
+node -e "
+  var p = require('./package.json');
+  delete p.private;
+  require('fs').writeFileSync('package.json', JSON.stringify(p, null, 2) + '\n');
+"
+
+if [ "$#" -gt 0 ]; then
+  yarn publish --new-version "$VERSION" "$@"
+else
+  yarn publish --new-version "$VERSION"
+fi

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforcedevs/sfdocs-e2e",
-  "version": "1.0.0-alpha.0",
+  "version": "1.0.0-alpha.11",
   "description": "E2E test suite for SFDocs static portal pages (SSG)",
   "license": "ISC",
   "bin": {
@@ -16,7 +16,9 @@
     "test:e2e": "TS_NODE_TRANSPILE_ONLY=true TS_NODE_PROJECT=./tsconfig.json wdio wdio.conf.js",
     "test:e2e:portal": "TS_NODE_TRANSPILE_ONLY=true TS_NODE_PROJECT=./tsconfig.json wdio portal-wdio.conf.js",
     "test:e2e:static:portal": "TS_NODE_TRANSPILE_ONLY=true TS_NODE_PROJECT=./tsconfig.json wdio static-portal-wdio.conf.js",
-    "test:scope-search": "TS_NODE_TRANSPILE_ONLY=true TS_NODE_PROJECT=./tsconfig.json wdio search-wdio.conf.js"
+    "test:scope-search": "TS_NODE_TRANSPILE_ONLY=true TS_NODE_PROJECT=./tsconfig.json wdio search-wdio.conf.js",
+    "release:alpha:e2e": "f() { bash bin/publish.sh $1 --tag alpha; }; f",
+    "release:e2e": "f() { bash bin/publish.sh $1; }; f"
   },
   "dependencies": {
     "@sa11y/wdio": "^7.0.0",

package/src/shared/specs/internalLinks.test.ts

@@ -0,0 +1,70 @@
+import GuidePage from '../pageobjects/guide.page';
+
+/**
+ * E2E tests for internal link resolution (internalReferencePlugin + referenceLinkTransformerPlugin).
+ * Covered: relative .md → .html resolution, guide-to-guide links, reference-to-guide links,
+ * external links.
+ **/
+describe('Internal link resolution', () => {
+    const UPDATE_ORDER_STATES_PAGE =
+        '/docs/commerce/test-cc-orders-api/guide/update-order-states.html';
+    const QUICK_START_PAGE = '/docs/commerce/test-cc-orders-api/guide/quick-start.html';
+    const REFERENCE_PAGE =
+        '/docs/success/sfdocs/references/markdown-cheatsheet/markdown-cheatsheet.html#how-to-link-between-overviews-guides-and-references';
+
+    let page: GuidePage;
+
+    it('should resolve relative guide link correctly', async () => {
+        page = new GuidePage(UPDATE_ORDER_STATES_PAGE);
+        page.open();
+        await page.waitPageLoad();
+
+        const ordersApiLink = await $('a.internal-link-guide[href*="orders-api-overview"]');
+        await ordersApiLink.waitForDisplayed();
+        const href = await ordersApiLink.getAttribute('href');
+        expect(href).not.toMatch(/\.md(?:\?|#|$)/);
+        expect(href).toContain('orders-api-overview.html');
+    });
+
+    it('should resolve guide linking in same folder correctly', async () => {
+        page = new GuidePage(QUICK_START_PAGE);
+        page.open();
+        await page.waitPageLoad();
+
+        await (await $('>>> doc-heading[hash="see-also"]')).waitForDisplayed();
+
+        const understandTheBasicsLink = await $('=Understand the Basics');
+        await understandTheBasicsLink.waitForDisplayed();
+        const href = await understandTheBasicsLink.getAttribute('href');
+        expect(href).not.toMatch(/\.md(?:\?|#|$)/);
+        expect(href).toContain('understand-the-basics.html');
+    });
+
+    it('should have html link for reference to guide linking', async () => {
+        page = new GuidePage(REFERENCE_PAGE);
+        page.open();
+        await page.waitPageLoad();
+
+        await (
+            await $('>>> doc-heading[hash="how-to-link-between-overviews-guides-and-references"]')
+        ).waitForDisplayed();
+
+        const threeContentTypesLink = await $('=three content types');
+        await threeContentTypesLink.waitForDisplayed();
+        const href = await threeContentTypesLink.getAttribute('href');
+        expect(href).toContain('guide');
+        expect(href).toMatch(/\.html(?:#|$|\?)/);
+    });
+
+    it('should treat external links as external', async () => {
+        page = new GuidePage(REFERENCE_PAGE);
+        page.open();
+        await page.waitPageLoad();
+
+        const externalLinks = await $$('a.external-link-guide');
+        expect(externalLinks.length).toBeGreaterThan(0);
+        for (const link of externalLinks) {
+            expect(await link.getAttribute('target')).toBe('_blank');
+        }
+    });
+});