feat: EPUPlayer release workflow with PyPI publishing by vredchenko · Pull Request #120 · DiamondLightSource/smartem-devtools

vredchenko · 2026-01-20T13:37:38Z

Summary

Implements GitHub Releases and PyPI publishing for EPUPlayer tool with:

Semantic versioning (starting v1.0.0)
Tag-triggered stable releases (epuplayer-v*)
RC pre-releases on push to main (with change detection)
Dual distribution: Windows exe + Python package

Closes #117

Changes

Package Restructuring

Moved fsrecorder from tools/fsrecorder/ to packages/smartem-epuplayer/
Renamed classes: FSRecorder → EPURecorder, FSReplayer → EPUReplayer, FSEvent → EPUEvent
Proper Python package with hatchling build backend
Modular code: models, recorder, replayer, cli
Entry point: epuplayer command
Tests with pytest

Release Workflow

release-epuplayer.yml: Tag → stable release (GitHub + PyPI), main push → RC (GitHub only)
Tests on Linux and Windows
PyInstaller Windows exe build with smoke tests
PyPI Trusted Publisher publishing

PR Automation

pr-admin.yml for auto-labeling and project board integration
labeler.yml with component:epuplayer label for monorepo

Documentation

ADR 0013: EPUPlayer Release Strategy
Updated e2e-simulation.md, deployment.md, smartem-agent-design.md
Updated CLAUDE.md and ARCHITECTURE.md

E2E Test Scripts

Updated run-e2e-test.sh and run-e2e-test-multi-microscope.sh to use epuplayer CLI

Setup Required After Merge

Configure PyPI Trusted Publishers for smartem-epuplayer
Create PROJECT_TOKEN secret for project board automation (or use org-level permissions)
Create GitHub environment named pypi

Test plan

Verify tests pass in CI (Linux + Windows)
Verify lint checks pass
Test RC release on merge to main
Test stable release with tag epuplayer-v1.0.0
Verify PyPI package installs: pip install smartem-epuplayer
Verify Windows exe runs: epuplayer.exe --help

Move fsrecorder from tools/fsrecorder/ to packages/smartem-fsrecorder/ with proper package structure: - pyproject.toml with hatchling build backend - Modular code: models, recorder, replayer, cli - Entry point: fsrecorder command - Tests with pytest - README with installation and usage docs Package name: smartem-fsrecorder Initial version: 1.0.0

Add release-fsrecorder.yml workflow: - Tag fsrecorder-v* triggers stable release to GitHub + PyPI - Push to main triggers RC pre-release to GitHub only - PR triggers build + test only - Tests on Linux and Windows - PyInstaller Windows exe build with smoke tests - PyPI Trusted Publisher publishing Add PR automation: - pr-admin.yml for auto-labeling and project board integration - labeler.yml with component labels for monorepo

Document key decisions for fsrecorder release workflow: - Dual distribution: Windows exe + Python package - Semantic versioning with fsrecorder-v* tags - RC releases on push to main, stable on tag - PyPI for stable releases only - Hybrid release notes generation

Delete tools/fsrecorder/ directory (code moved to packages/) Delete build_win_fsrecorder.yml (replaced by release-fsrecorder.yml)

Comprehensive rename of fsrecorder to epuplayer including: Package and module: - smartem-fsrecorder -> smartem-epuplayer - smartem_fsrecorder -> smartem_epuplayer Classes: - FSRecorder -> EPURecorder - FSReplayer -> EPUReplayer - FSEvent -> EPUEvent CLI and executables: - fsrecorder -> epuplayer - fsrecorder.exe -> epuplayer.exe CI/CD: - release-fsrecorder.yml -> release-epuplayer.yml - Tag pattern: fsrecorder-v* -> epuplayer-v* - Label: component:fsrecorder -> component:epuplayer Documentation: - ADR 0013 renamed and updated - e2e-simulation.md updated - deployment.md updated - smartem-agent-design.md updated - CLAUDE.md and ARCHITECTURE.md updated Tools: - E2E test scripts updated to use epuplayer CLI - Workspace pyproject.toml optional dep renamed

- Fix remaining documentation references to fsrecorder - Update recording filenames from _fsrecord to _epurecording - Add component:epuplayer label to GitHub labels config - Sync labels (deletes old component:fsrecorder, updates epuplayer)

vredchenko · 2026-01-20T14:22:41Z

CI Failures

Windows Test Failure - Path normalization issue:
AssertionError:
WindowsPath('C:/Users/runneradmin/...') == WindowsPath('C:/Users/RUNNER1/...')
The fixture passes a short path form (RUNNER1) but EPURecorder resolves it to the full form (runneradmin). The test at test_integration.py:38 does a strict equality check. Fix needed in test or recorder.
Project Board Failure - Missing secret:
Input required and not supplied: github-token
The pr-admin.yml workflow uses actions/add-to-project which needs a PROJECT_TOKEN secret with project access (personal access token with project scope).

PyPI Configuration Needed

Yes, before the first publish you need to configure Trusted Publishers on PyPI:

Go to https://pypi.org/ → Your projects → Add project (or create smartem-epuplayer first)
Under Publishing → Add a new pending publisher:
- Owner: DiamondLightSource
- Repository: smartem-devtools
- Workflow name: release-epuplayer.yml
- Environment: pypi

This enables OIDC-based publishing (no API tokens needed).

EPURecorder.watch_dir is intentionally resolved for consistent path handling. Test now compares against resolved fixture path to handle Windows short path forms (e.g., RUNNER~1 vs runneradmin).

vredchenko · 2026-01-20T14:38:24Z

Step 1: Create a PAT with project access

Go to https://github.com/settings/tokens?type=beta (Fine-grained tokens)
Click "Generate new token"
Name: SmartEM Project Board
Repository access: DiamondLightSource/smartem-devtools (or All repositories)
Permissions → Organization permissions → Projects: Read and write
Generate and copy the token

Step 2: Add secret to repo

Go to https://github.com/DiamondLightSource/smartem-devtools/settings/secrets/actions
Click "New repository secret"
Name: PROJECT_TOKEN
Value: paste the PAT from step 1
Click "Add secret"

Alternatively, if you have the token already, you can add it via CLI:
gh secret set PROJECT_TOKEN --repo DiamondLightSource/smartem-devtools
(It will prompt you to paste the token value)

- Update labeler.yml to use labels from github-labels-config.ts - Map docs → documentation, ci → devops, webui → smartem-devtools:webui, etc. - Add component:smartem-workspace to labels config - Sync labels (delete orphaned labels, create missing ones) This prevents github-actions bot from recreating unofficial labels that were deleted by the label sync script.

vredchenko added 4 commits January 20, 2026 13:36

chore: remove old fsrecorder location and build workflow

a8809ea

Delete tools/fsrecorder/ directory (code moved to packages/) Delete build_win_fsrecorder.yml (replaced by release-fsrecorder.yml)

vredchenko added devops CI/CD, deployment, infrastructure, or tooling work enhancement Minor improvements to existing functionality smartem-devtools Developer tooling, documentation, and workspace configuration labels Jan 20, 2026

github-actions bot added component:fsrecorder labels Jan 20, 2026

github-actions bot added component:epuplayer EPUPlayer filesystem recording and replay tool claude-code labels Jan 20, 2026

vredchenko changed the title ~~feat: FSRecorder release workflow with PyPI publishing~~ feat: EPUPlayer release workflow with PyPI publishing Jan 20, 2026

vredchenko removed ci labels Jan 20, 2026

github-actions bot added docs labels Jan 20, 2026

vredchenko marked this pull request as ready for review January 20, 2026 14:18

vredchenko mentioned this pull request Jan 20, 2026

Add RC release workflow for smartem-workspace (align with epuplayer pattern) #122

Closed

fix(epuplayer): compare resolved paths in test

5b26fd5

EPURecorder.watch_dir is intentionally resolved for consistent path handling. Test now compares against resolved fixture path to handle Windows short path forms (e.g., RUNNER~1 vs runneradmin).

vredchenko removed ci labels Jan 20, 2026

github-actions bot added documentation Improvements or additions to project documentation smartem-devtools:claude Claude Code configuration, skills, and prompts smartem-devtools:e2e-test End-to-end testing infrastructure and scenarios labels Jan 20, 2026

vredchenko merged commit 4b2f0eb into main Jan 20, 2026
13 of 15 checks passed

vredchenko deleted the feat/fsrecorder-release-workflow branch January 20, 2026 14:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: EPUPlayer release workflow with PyPI publishing#120

feat: EPUPlayer release workflow with PyPI publishing#120
vredchenko merged 8 commits intomainfrom
feat/fsrecorder-release-workflow

vredchenko commented Jan 20, 2026 •

edited

Loading

Uh oh!

vredchenko commented Jan 20, 2026

Uh oh!

vredchenko commented Jan 20, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

vredchenko commented Jan 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes

Package Restructuring

Release Workflow

PR Automation

Documentation

E2E Test Scripts

Setup Required After Merge

Test plan

Uh oh!

vredchenko commented Jan 20, 2026

Uh oh!

vredchenko commented Jan 20, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

vredchenko commented Jan 20, 2026 •

edited

Loading