Skip to content

docs: add missing AGENTS.md (and README where missing) #92

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
trly wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add missing AGENTS.md (and README where missing) #92

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 64 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# AGENTS.md

Guidance for coding agents working in this repository.

## Overview

`@sourcegraph/smoke-tests` is a Yarn workspaces monorepo of smoke tests run against
Sourcegraph instances. It contains two packages under `packages/`:

- `web-functionality` (`@sourcegraph/web-smoke-tests`) — Puppeteer/Jest checks that a
deployed instance functions correctly. Source lives in `packages/web-functionality/src`,
with the entrypoint at `src/index.js`. Published to npm via semantic-release.
- `web-performance` (`@sourcegraph/web-smoke-performance`) — periodic Lighthouse audits
against Sourcegraph.com, driven by `packages/web-performance/report.sh`. Results are
committed to `packages/web-performance/reports/`.

The repo is TypeScript (compiled with `tsc`), targeting Node `16.7.0` (see `.nvmrc`).

## Setup

```bash
nvm use # Node 16.7.0, per .nvmrc
yarn # install all workspace dependencies
```

## Common commands

Run package scripts from within the relevant package directory.

`packages/web-functionality`:

```bash
yarn build # tsc
yarn test # build, then run checks against https://sourcegraph.com/search
yarn eslint # lint '**/*.[tj]s'
yarn prettier-check # prettier --check .
```

Run the published functionality tests against an instance:

```bash
SOURCEGRAPH_URL="https://sourcegraph.com" npx @sourcegraph/web-smoke-tests@latest start
```

`packages/web-performance` (requires `jq` and the LHCI CLI from deps):

```bash
./report.sh "<name>" "<url>" ./reports/<file>.json
```

## Conventions

- Commit messages follow [Conventional Commits](https://conventionalcommits.org/) and are
linted by commitlint via a Husky `commit-msg` hook. Use `git commit --no-verify` or
`fixup!` autosquash for fixup commits.
- Releases are automated in CI (`semantic-release`) on merges to `main`.
- ESLint config extends `@sourcegraph/eslint-config`; Prettier extends `@sourcegraph/prettierrc`.

## CI

- `.github/workflows/build.yml` — on push/PR: installs deps, runs `prettier-check`,
`eslint`, `build` for `web-functionality`, and releases on `main`.
- `.github/workflows/lighthouse.yml` — scheduled (every 4 hours) and manual; runs the
Lighthouse audits and commits the generated reports.
Loading