@salesforcedevs/sfdocs-e2e 1.0.3 → 1.0.4-skip-footer

package/README.md

@@ -43,11 +43,6 @@ 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
@@ -159,18 +154,13 @@ 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)**
 
+> The e2e package is marked `"private": true` so it is automatically skipped during the monorepo's standard `yarn release` workflow.
+
 ```bash
 cd packages/e2e
-yarn release:alpha:e2e 1.0.0-alpha.0
+yarn publish --tag alpha --new-version 1.0.0-alpha.0
 ```
 
 The `alpha` dist-tag means `yarn add @salesforcedevs/sfdocs-e2e` will **not** resolve this version by default — consumers must opt in explicitly:
@@ -189,20 +179,19 @@ Iterate on alphas as needed (`1.0.0-alpha.1`, `1.0.0-alpha.2`, ...) until the re
 
 ```bash
 cd packages/e2e
-yarn release:e2e 1.0.0
+yarn publish --tag latest --new-version 1.0.0
 ```
 
 **3. Future releases — bump and publish**
 
 ```bash
-cd packages/e2e
-
 # Bug fix
-yarn release:e2e 1.0.1
+cd packages/e2e
+yarn publish --tag latest --new-version 1.0.1
 
 # New feature
-yarn release:e2e 1.1.0
+yarn publish --tag latest --new-version 1.1.0
 
 # Breaking change
-yarn release:e2e 2.0.0
+yarn publish --tag latest --new-version 2.0.0
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforcedevs/sfdocs-e2e",
-  "version": "1.0.3",
+  "version": "1.0.4-skip-footer",
   "description": "E2E test suite for SFDocs static portal pages (SSG)",
   "license": "ISC",
   "bin": {
@@ -17,8 +17,10 @@
     "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",
-    "release:alpha:e2e": "f() { bash bin/publish.sh $1 --tag alpha; }; f",
-    "release:e2e": "f() { bash bin/publish.sh $1; }; f"
+    "prepublish:e2e": "node -e \"const p=require('./package.json'); delete p.private; require('fs').writeFileSync('./package.json', JSON.stringify(p, null, 2)+'\\n')\"",
+    "postpublish:e2e": "node -e \"const p=require('./package.json'); p.private=true; require('fs').writeFileSync('./package.json', JSON.stringify(p, null, 2)+'\\n')\"",
+    "release:alpha:e2e": "f() { yarn prepublish:e2e && yarn publish --tag alpha --new-version $1; yarn postpublish:e2e; }; f",
+    "release:e2e": "f() { yarn prepublish:e2e && yarn publish --new-version $1; yarn postpublish:e2e; }; f"
   },
   "dependencies": {
     "@sa11y/wdio": "^7.0.0",

package/src/content-repo/specs/homepage.test.ts

@@ -13,7 +13,7 @@ describe('Homepage', () => {
     it('should show the expected number of projects', async () => {
         const projectCards = await HomePage.projectCards;
 
-        expect(projectCards.length).toEqual(18);
+        expect(projectCards.length).toEqual(17);
     });
 
     // it('is accessible', () => {

package/src/shared/pageobjects/page.ts

@@ -44,15 +44,15 @@ export default class Page {
         );
     }
 
-    async getHeader(headerTag = 'dx-global-header'): Promise<WebdriverIO.Element> {
-        return await $(headerTag);
+    async getHeader(): Promise<WebdriverIO.Element> {
+        return await $('hgf-c360contextnav');
     }
 
     async getHeaderTitle(): Promise<WebdriverIO.Element> {
         return (await $('>>>header')).$('h4');
     }
 
-    async getGlobalSearchBox(headerTag = 'dx-global-header'): Promise<WebdriverIO.Element> {
+    async getGlobalSearchBox(headerTag = 'dx-header'): Promise<WebdriverIO.Element> {
         return (await $(headerTag)).shadow$('dx-header-search');
     }
 

package/src/shared/specs/layout-tests.ts

@@ -7,7 +7,7 @@ import Page from '../pageobjects/page';
  * @param givenPage : This is the current page for which we need to test chrome.
  */
 
-export default function layoutTest(givenPage: Page, headerTag = 'dx-global-header') {
+export default function layoutTest(givenPage: Page, headerTag = 'dx-header') {
     let page: Page;
     describe('Basic layout testing > ', () => {
         beforeEach(async () => {
@@ -15,12 +15,10 @@ export default function layoutTest(givenPage: Page, headerTag = 'dx-global-heade
         });
 
         it('should display header', async () => {
-            const header = await $(headerTag);
+            const header = await $('hgf-c360contextnav');
             await header.waitForDisplayed();
             expect(await header.isDisplayed()).toBeTruthy();
-            if (headerTag === 'dx-global-header') {
-                expect(await header.getText()).toContain('Developers');
-            }
+            expect(await header.getText()).toContain('Developers');
         });
 
         it.skip('should display global search box', async () => {

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

@@ -179,10 +179,8 @@ describe('Reference Versioning', () => {
 
         await referencePage.waitForSpecBasedReferencePageLoad();
         await referencePage.selectVersion();
-        await referencePage.waitForSpecBasedReferencePageLoad();
 
         const container = await $('>>>div.title-area div');
-        await container.waitForDisplayed();
         const apiTitle = await container.getText();
 
         expect(apiTitle).toEqual('createBasket');
@@ -276,7 +274,6 @@ describe('Spec-Based Flexible References', () => {
         await referencePage.waitForSpecBasedReferencePageLoad();
 
         const container = await $('>>>div.title-area div');
-        await container.waitForDisplayed();
         const apiTitle = await container.getText();
 
         expect(apiTitle).toEqual('getBasket');

package/static-portal-wdio.conf.js

@@ -24,6 +24,13 @@ exports.config = {
         './src/portal/specs/docs.test.ts',
     ],
 
+    // Skip footer tests - footer is not available in static builds
+    mochaOpts: {
+        ...BASE_CONFIG.config.mochaOpts,
+        grep: 'should display footer',
+        invert: true,
+    },
+
     // Output directory for static test results
     outputDir: './_results_/static-portal',
 

package/bin/publish.sh

@@ -1,31 +0,0 @@
-#!/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/src/shared/specs/internalLinks.test.ts

@@ -1,70 +0,0 @@
-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');
-        }
-    });
-});