Skip to content

enhancement: add CI smoke tests and cross-platform gating before release #25

@BraedenBDev

Description

@BraedenBDev

Summary

crawl-sim has a publish workflow, but it does not currently have CI that gates merges on test, smoke, and cross-platform script validation.

That gap is directly related to several defects found in the public-release audit:

  • macOS-only robots.txt regression
  • broken compare report generation on the happy path
  • report-generator security regression

These are exactly the kinds of failures that a lightweight CI matrix should catch before release tags are cut.

Current state

  • tests exist and pass locally (npm test)
  • publish workflow exists
  • branch protection on main is effectively off
  • no mandatory CI status check is present for release-critical paths

Suggested improvements

  1. Add a CI workflow that runs on push and pull_request.
  2. Run at least:
    • npm test
    • a compare-report smoke test
    • an HTML-report generation smoke test
  3. Add a small OS matrix for shell portability:
    • ubuntu-latest
    • macos-latest
  4. Wire branch protection to require the CI workflow before merging.

Why this matters

This repo is positioning itself as a public OSS tool and npm/plugin install target. Release confidence should come from automation, not just local verification.

Acceptance criteria

  • A CI workflow runs on pushes and PRs.
  • npm test is part of CI.
  • CI includes at least one compare-report smoke test.
  • CI includes at least one HTML-report generation smoke test.
  • CI runs on both Linux and macOS.
  • main is protected by required CI status checks.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions