project-action

Action for testing projects

Install

make setup

Build

make build

Test Artifacts Convention

Tests inside the Docker container should write artifacts (screenshots, traces, HTML reports) to /project/tmp/artifacts/.

The project's docker-compose.yml must mount the source directory to /project:

services:
  app:
    volumes:
      - .:/project
    working_dir: /project

After tests finish, the action automatically uploads everything under /project/tmp/artifacts/ as a test-results GitHub Actions artifact. Students download it and open playwright-report/index.html locally.

Only files are collected — directories are not added to the archive as entries of their own, and empty ones are skipped. Keep artifact paths ASCII: non-ASCII names survive into the zip and are rendered inconsistently across archivers and operating systems.

Example playwright.config.js:

export default defineConfig({
  outputDir: '/project/tmp/artifacts/traces',
  reporter: [['html', { outputFolder: '/project/tmp/artifacts/playwright-report', open: 'never' }]],
  use: {
    trace: 'retain-on-failure',
    screenshot: 'only-on-failure',
  },
});

This repository is created and maintained by the team and the community of Hexlet, an educational project. Read more about Hexlet.