Skip to content

update services page for length and clarity #137

update services page for length and clarity

update services page for length and clarity #137

Workflow file for this run

name: Preview Deployment
on:
pull_request:
types: [opened, reopened, synchronize, closed]
env:
FLY_API_TOKEN: ${{ secrets.FLY_PREVIEW_API_TOKEN }}
FLY_REGION: iad
FLY_ORG: ${{ vars.FLY_PREVIEW_ORG }}
permissions:
contents: read
pull-requests: write
jobs:
preview:
runs-on: ubuntu-latest
outputs:
url: ${{ steps.deploy.outputs.url }}
concurrency:
group: pr-${{ github.event.number }}
environment:
name: preview
url: ${{ steps.deploy.outputs.url }}
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Deploy preview app
id: deploy
uses: superfly/[email protected]
with:
config: fly.preview.toml
vmsize: shared-cpu-1x
memory: 256
- name: Comment on PR
if: github.event.action != 'closed'
continue-on-error: true
uses: actions/github-script@v7
with:
script: |
const url = '${{ steps.deploy.outputs.url }}';
const sha = context.sha.substring(0, 7);
const body = `### Preview Deployment\n\n| Name | URL |\n|------|-----|\n| Preview | ${url} |\n\nCommit: \`${sha}\``;
// Find existing comment
const { data: comments } = await github.rest.issues.listComments({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: context.issue.number,
});
const existing = comments.find(c => c.body.includes('### Preview Deployment'));
if (existing) {
await github.rest.issues.updateComment({
owner: context.repo.owner,
repo: context.repo.repo,
comment_id: existing.id,
body,
});
} else {
await github.rest.issues.createComment({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: context.issue.number,
body,
});
}
e2e-test:
name: E2E Tests
runs-on: ubuntu-latest
needs: preview
if: github.event.action != 'closed'
continue-on-error: true
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup pnpm
uses: pnpm/action-setup@v4
with:
version: latest
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: 22
cache: pnpm
- name: Install dependencies
run: pnpm install --frozen-lockfile
- name: Install Cypress binary
run: pnpm cypress install
- name: Wait for preview to be ready
run: |
echo "Waiting for preview deployment to be ready..."
for i in {1..30}; do
if curl -s -o /dev/null -w "%{http_code}" "${{ needs.preview.outputs.url }}" | grep -q "200"; then
echo "Preview is ready!"
exit 0
fi
echo "Attempt $i: Preview not ready yet, waiting 10s..."
sleep 10
done
echo "Preview did not become ready in time"
exit 1
- name: Run Cypress tests
uses: cypress-io/github-action@v6
with:
browser: chrome
install: false
env:
CYPRESS_BASE_URL: ${{ needs.preview.outputs.url }}
- name: Upload screenshots on failure
uses: actions/upload-artifact@v4
if: failure()
with:
name: cypress-screenshots
path: cypress/screenshots
retention-days: 7
- name: Upload videos on failure
uses: actions/upload-artifact@v4
if: failure()
with:
name: cypress-videos
path: cypress/videos
retention-days: 7
- name: Comment test results on PR
if: always()
uses: actions/github-script@v7
with:
script: |
const status = '${{ job.status }}';
const emoji = status === 'success' ? 'βœ…' : '❌';
const body = `### E2E Test Results\n\n${emoji} Tests ${status}\n\nRan against: ${{ needs.preview.outputs.url }}`;
const { data: comments } = await github.rest.issues.listComments({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: context.issue.number,
});
const existing = comments.find(c => c.body.includes('### E2E Test Results'));
if (existing) {
await github.rest.issues.updateComment({
owner: context.repo.owner,
repo: context.repo.repo,
comment_id: existing.id,
body,
});
} else {
await github.rest.issues.createComment({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: context.issue.number,
body,
});
}
lighthouse:
name: Lighthouse CI
runs-on: ubuntu-latest
needs: preview
if: github.event.action != 'closed'
continue-on-error: true
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Wait for preview to be ready
run: |
echo "Waiting for preview deployment to be ready..."
for i in {1..30}; do
if curl -s -o /dev/null -w "%{http_code}" "${{ needs.preview.outputs.url }}" | grep -q "200"; then
echo "Preview is ready!"
exit 0
fi
echo "Attempt $i: Preview not ready yet, waiting 10s..."
sleep 10
done
echo "Preview did not become ready in time"
exit 1
- name: Get changed pages
id: changed-pages
uses: actions/github-script@v7
with:
script: |
const { data: files } = await github.rest.pulls.listFiles({
owner: context.repo.owner,
repo: context.repo.repo,
pull_number: context.issue.number,
});
const baseUrl = '${{ needs.preview.outputs.url }}';
const urls = new Set([baseUrl]); // Always test homepage
for (const file of files) {
// Match .mdx files in src/content/docs/
const match = file.filename.match(/^src\/content\/docs\/(.+)\.mdx$/);
if (match && file.status !== 'removed') {
let path = match[1];
// index.mdx maps to root, others map to their path
if (path === 'index') {
urls.add(baseUrl);
} else {
urls.add(`${baseUrl}/${path}/`);
}
}
}
const urlList = Array.from(urls).join('\n');
console.log('URLs to test:\n' + urlList);
core.setOutput('urls', urlList);
- name: Run Lighthouse CI
id: lighthouse
uses: treosh/lighthouse-ci-action@v12
with:
urls: ${{ steps.changed-pages.outputs.urls }}
configPath: ./lighthouserc.json
budgetPath: ./budget.json
uploadArtifacts: true
temporaryPublicStorage: true
- name: Comment Lighthouse results on PR
if: always()
uses: actions/github-script@v7
with:
script: |
const manifest = ${{ steps.lighthouse.outputs.manifest }};
const links = ${{ steps.lighthouse.outputs.links }};
let body = '### Lighthouse Results\n\n';
body += '| URL | Performance | Accessibility | Best Practices | SEO |\n';
body += '|-----|-------------|---------------|----------------|-----|\n';
for (const result of manifest) {
const url = new URL(result.url).pathname || '/';
const perf = Math.round(result.summary.performance * 100);
const a11y = Math.round(result.summary.accessibility * 100);
const bp = Math.round(result.summary['best-practices'] * 100);
const seo = Math.round(result.summary.seo * 100);
const perfEmoji = perf >= 90 ? '🟒' : perf >= 50 ? '🟠' : 'πŸ”΄';
const a11yEmoji = a11y >= 90 ? '🟒' : a11y >= 50 ? '🟠' : 'πŸ”΄';
const bpEmoji = bp >= 90 ? '🟒' : bp >= 50 ? '🟠' : 'πŸ”΄';
const seoEmoji = seo >= 90 ? '🟒' : seo >= 50 ? '🟠' : 'πŸ”΄';
const reportLink = links[result.url] ? `[${url}](${links[result.url]})` : url;
body += `| ${reportLink} | ${perfEmoji} ${perf} | ${a11yEmoji} ${a11y} | ${bpEmoji} ${bp} | ${seoEmoji} ${seo} |\n`;
}
const { data: comments } = await github.rest.issues.listComments({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: context.issue.number,
});
const existing = comments.find(c => c.body.includes('### Lighthouse Results'));
if (existing) {
await github.rest.issues.updateComment({
owner: context.repo.owner,
repo: context.repo.repo,
comment_id: existing.id,
body,
});
} else {
await github.rest.issues.createComment({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: context.issue.number,
body,
});
}