Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 12 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,21 @@

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project aims to follow Semantic Versioning once public releases start.
The format is based on Keep a Changelog, and this project aims to follow Semantic Versioning for public releases.

## [Unreleased]

- Nothing unreleased yet.
Nothing unreleased yet.

## [0.2.3] - 2026-06-06

- Added a `--browser-channel` CLI override so captures can use installed Chromium-family browsers like Chrome or Edge.
- Documented the FFmpeg, SVG rasterizer, and Playwright video dependencies needed for the quickstart.
- Cleaned up browser, context, and service teardown when capture setup fails before recording starts.

## [0.2.2] - 2026-03-09

- Re-published package metadata for the release toolchain.

## [0.2.1] - 2026-03-09

Expand Down
15 changes: 8 additions & 7 deletions RELEASING.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
# Releasing

This repo is set up to be published as the `screenstage` npm package on npmjs.org, with a scoped GitHub Packages mirror published from tags.
This repo publishes the `screenstage` npm package on npmjs.org, with a scoped GitHub Packages mirror published from version tags.

## Before The First Public Release
## Release Setup

1. Confirm the npm package name is still available.
2. Configure npm trusted publishing for this repo and its `release.yml` workflow.
3. Make sure the public repo metadata in `package.json` matches the live GitHub repo.
4. Keep the release workflow on `Node >= 22.14.0` and `npm >= 11.5.1`, which npm currently requires for trusted publishing.
- The npm package name is `screenstage`.
- `package.json` points at `https://github.com/jodonnell24/screenstage`.
- The release workflow uses npm trusted publishing for npmjs.org.
- The release workflow also publishes a scoped GitHub Packages mirror.
- The workflow runs on Node 22.14.0 and upgrades npm before publishing.

## Local Release Checklist

Expand Down Expand Up @@ -39,7 +40,7 @@ npm run pack:check
git push --follow-tags
```

6. Publish manually if you want to ship before using GitHub Actions:
6. Publish manually only if you intentionally want to bypass the tag workflow:

```bash
npm publish --access public
Expand Down
Loading
Loading