Grammarly CI Integration

Overview

Set up CI/CD pipelines for Grammarly integrations with automated testing.

Prerequisites

• GitHub repository with Actions enabled
• Grammarly test API key
• npm/pnpm project configured

Instructions

Step 1: Create GitHub Actions Workflow

Create .github/workflows/grammarly-integration.yml:

name: Grammarly Integration Tests

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

env:
  GRAMMARLY_API_KEY: ${{ secrets.GRAMMARLY_API_KEY }}

jobs:
  test:
    runs-on: ubuntu-latest
    env:
      GRAMMARLY_API_KEY: ${{ secrets.GRAMMARLY_API_KEY }}
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: '20'
          cache: 'npm'
      - run: npm ci
      - run: npm test -- --coverage
      - run: npm run test:integration

Step 2: Configure Secrets

gh secret set GRAMMARLY_API_KEY --body "sk_test_***"

Step 3: Add Integration Tests

describe('Grammarly Integration', () => {
  it.skipIf(!process.env.GRAMMARLY_API_KEY)('should connect', async () => {
    const client = getGrammarlyClient();
    const result = await client.healthCheck();
    expect(result.status).toBe('ok');
  });
});

Output

• Automated test pipeline
• PR checks configured
• Coverage reports uploaded
• Release workflow ready

Error Handling

Examples

Release Workflow

on:
  push:
    tags: ['v*']

jobs:
  release:
    runs-on: ubuntu-latest
    env:
      GRAMMARLY_API_KEY: ${{ secrets.GRAMMARLY_API_KEY_PROD }}
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: '20'
      - run: npm ci
      - name: Verify Grammarly production readiness
        run: npm run test:integration
      - run: npm run build
      - run: npm publish

Branch Protection

required_status_checks:
  - "test"
  - "grammarly-integration"

Resources

• GitHub Actions Documentation
• Grammarly CI Guide

Next Steps

For deployment patterns, see grammarly-deploy-integration.