CI / CD Integration

export const SCAN_TARGETS = [
  {
    tab: 'Shop',
    stackScreen: 'Home',
    sdkName: 'HomeScreen',
    route: '/HomeScreen',
  },
  {
    tab: 'Shop',
    stackScreen: 'ProductDetail',
    stackParams: { product: SAMPLE_PRODUCT },
    sdkName: 'ProductDetailScreen',
    route: '/ProductDetailScreen',
  },
  {
    tab: 'Profile',
    sdkName: 'ProfileScreen',
    route: '/ProfileScreen',
  },
];

// 1. Clear dedup cache
WelcomingWeb.clearScreenCache();
 
// 2. Override callback for this run
WelcomingWeb.configure({
  ...SDK_CONFIG,
  autoScan: true,
  onScanComplete: (result) => {
    resolverMapRef.current.get(result.screenName)?.resolve(result);
  },
});
 
// 3. Scan each screen in sequence
for (const target of SCAN_TARGETS) {
  const scanPromise = waitForScan(target.sdkName);   // 8 s timeout
  navigateTo(target);                                // triggers useFocusEffect
  await sleep(SCAN_WAIT_MS);                         // 2000 ms margin
  const result = await scanPromise;                  // resolved by onScanComplete
  collectResult(result);
}
 
// 4. Submit session
const session = await WelcomingWeb.submitScanSession({ scanType: 'ci_build' });
 
// 5. Restore original config
WelcomingWeb.configure(SDK_CONFIG);

name: Accessibility Scan
 
on:
  pull_request:
  push:
    branches: [main, develop]
 
jobs:
  a11y-scan:
    runs-on: macos-latest
    timeout-minutes: 30
 
    env:
      WELCOMINGWEB_API_KEY: ${{ secrets.WELCOMINGWEB_API_KEY }}
      WELCOMINGWEB_APP_ID:  ${{ secrets.WELCOMINGWEB_APP_ID }}
      APP_VERSION:          ${{ github.ref_name }}
      BUILD_ID:             ${{ github.run_id }}
      COMMIT_SHA:           ${{ github.sha }}
 
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: 20
          cache: yarn
 
      - name: Install dependencies
        run: yarn install --frozen-lockfile
 
      - name: Install Detox CLI
        run: yarn global add detox-cli
 
      - name: Build app (debug)
        run: detox build --configuration ios.sim.debug
 
      - name: Boot simulator
        run: xcrun simctl boot "iPhone 15"
 
      - name: Run accessibility scan
        run: |
          detox test --configuration ios.sim.debug \
            --testNamePattern "Accessibility CI"
        env:
          A11Y_FAIL_ON_CRITICAL: 'true'
          A11Y_MIN_SCORE:        '75'
 
      - name: Upload session report
        if: always()
        uses: actions/upload-artifact@v4
        with:
          name: a11y-report
          path: e2e/artifacts/

import { device, element, by, expect as detoxExpect } from 'detox';
 
describe('Accessibility CI', () => {
  beforeAll(async () => {
    await device.launchApp({ newInstance: true });
  });
 
  it('passes full accessibility scan', async () => {
    await element(by.label('CI Scan')).tap();
    await element(by.label('Run full CI scan')).tap();
 
    await detoxExpect(
      element(by.text('BUILD PASSED').or(by.text('BUILD FAILED')))
    ).toBeVisible(60000);
 
    await detoxExpect(element(by.text('BUILD FAILED'))).not.toBeVisible();
  });
});

workflows:
  accessibility_scan:
    steps:
      - git-clone@8: {}
      - yarn@0:
          inputs:
            - command: install --frozen-lockfile
      - script@1:
          title: Run WelcomingWeb accessibility scan
          inputs:
            - content: |
                #!/usr/bin/env bash
                set -euo pipefail
 
                export WELCOMINGWEB_API_KEY="$WELCOMINGWEB_API_KEY"
                export APP_VERSION="$BITRISE_BUILD_NUMBER"
                export BUILD_ID="$BITRISE_BUILD_SLUG"
                export COMMIT_SHA="$GIT_CLONE_COMMIT_HASH"
 
                yarn detox test \
                  --configuration android.emu.debug \
                  --testNamePattern "Accessibility CI"
                echo "Scan complete."
 
      - slack@4:
          title: Notify accessibility result
          is_always_run: true
          inputs:
            - webhook_url: "$SLACK_WEBHOOK"
            - channel: "#mobile-a11y"
            - message: |
                *Accessibility Scan* $BITRISE_APP_TITLE
                Build: $BITRISE_BUILD_NUMBER | $BITRISE_BUILD_STATUS_TEXT
                Dashboard: https://app.welcomingweb.com/apps/$WELCOMINGWEB_APP_ID

platform :ios do
  desc "Run WelcomingWeb accessibility scan"
  lane :a11y_scan do |options|
    min_score        = options[:min_score]        || 75
    fail_on_critical = options[:fail_on_critical] != false  # default true
 
    ENV['WELCOMINGWEB_API_KEY']   = ENV['WELCOMINGWEB_API_KEY']
    ENV['APP_VERSION']            = lane_context[SharedValues::VERSION_NUMBER]
    ENV['BUILD_ID']               = ENV['CI_BUILD_ID'] || 'local'
    ENV['COMMIT_SHA']             = last_git_commit[:commit_hash]
    ENV['A11Y_MIN_SCORE']         = min_score.to_s
    ENV['A11Y_FAIL_ON_CRITICAL']  = fail_on_critical.to_s
 
    build_app(
      scheme: "YourAppScheme",
      configuration: "Debug",
      skip_codesigning: true
    )
 
    sh("yarn detox test --configuration ios.sim.debug " \
       "--testNamePattern 'Accessibility CI'")
 
    UI.success "Accessibility scan complete. Check the dashboard for results."
  end
end

# From the command line
bundle exec fastlane a11y_scan
 
# With custom threshold
bundle exec fastlane a11y_scan min_score:80 fail_on_critical:true
 
# From another lane
lane :release do
  a11y_scan(min_score: 80)
  gym
  pilot
end

appId: com.yourcompany.yourapp
---
 
# 1. Launch the app fresh
- launchApp:
    clearState: true
 
# 2. Open the CI runner tab
- tapOn:
    text: "CI Scan"
 
# 3. Start the scan
- tapOn:
    accessibilityLabel: "Run full CI scan"
 
# 4. Wait up to 60 s for the verdict
- waitForAnimationToEnd:
    timeout: 60000
 
# 5. Assert pass (fails if BUILD FAILED is visible)
- assertNotVisible:
    text: "BUILD FAILED"
 
- assertVisible:
    text: "BUILD PASSED"

# Install
curl -Ls "https://get.maestro.mobile.dev" | bash
 
# Run the accessibility flow
maestro test .maestro/a11y_scan.yaml
 
# Run against a specific device
maestro --device <udid> test .maestro/a11y_scan.yaml

workflows:
  accessibility-scan:
    name: Accessibility Scan
    environment:
      vars:
        WELCOMINGWEB_API_KEY: $WELCOMINGWEB_API_KEY
        WELCOMINGWEB_APP_ID:  $WELCOMINGWEB_APP_ID
    scripts:
      - flutter pub get
      - flutter build apk --debug
      - flutter test integration_test/a11y_test.dart

./gradlew :app:connectedAndroidTest \
  -PtestClass=com.yourcompany.app.AccessibilityCiTest \
  -PWELCOMINGWEB_API_KEY=$WELCOMINGWEB_API_KEY

const result = await WelcomingWeb.submitScanSession({ scanType: 'ci_build' });
 
const MIN_SCORE = parseInt(process.env.A11Y_MIN_SCORE || '0', 10);
const failOnCritical = process.env.A11Y_FAIL_ON_CRITICAL === 'true';
 
if (failOnCritical && result.criticalIssues > 0) {
  console.error(
    `A11Y FAIL: ${result.criticalIssues} critical issue(s). Fix before shipping.`
  );
  process.exit(1);
}
 
if (MIN_SCORE > 0 && result.accessibilityScore < MIN_SCORE) {
  console.error(
    `A11Y FAIL: score ${result.accessibilityScore} < minimum ${MIN_SCORE}.`
  );
  process.exit(1);
}
 
console.log(
  `A11Y PASS: score ${result.accessibilityScore} (${result.totalIssues} issues)`
);