From 77881b39b0ef2a0a459a177134bc0f51c2ec0141 Mon Sep 17 00:00:00 2001 From: Shin'ya Ueoka Date: Sat, 9 May 2026 23:04:25 +0900 Subject: [PATCH 1/2] docs: rewrite README with heading, version formats, platform support, and parameters - Rewrite intro with feature bullet list - Add Supported version formats section - Add Supported platforms table - Add Parameters section with inputs and outputs Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- README.md | 32 ++++++++++++++++++++++++++++++-- 1 file changed, 30 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9371c46..f7e17d0 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,12 @@ # setup-firefox -This action sets by Firefox for use in actions by: +This action sets up Mozilla Firefox for GitHub Actions. This action supports the following features: -- downloading and caching a version of Firefox by version and add to PATH +- Install and set up Firefox onto the runner. +- Install a specific version of Firefox by the version number or release channel. +- Cross-platform runner support (Windows, macOS, Linux) and self-hosted runner support. +- Support for Firefox release channels: stable, beta, developer edition, nightly, and ESR. ## Usage @@ -38,6 +41,31 @@ jobs: ${{ steps.setup-firefox.outputs.firefox-path }} --version ``` +### Supported version formats + +The action supports the following version formats: + +- Release channels: `latest` (default), `latest-beta`, `latest-devedition`, `latest-nightly`, `latest-esr` +- Specific release version: `84.0`, `84.0.1`, `beta-84.0b1`, `devedition-84.0b1` + +## Supported platforms + +| Linux x64 | Linux ARM32 | Linux ARM64 | macOS x64 | macOS ARM64 | Windows x64 | Windows ARM64 | +| --- | --- | --- | --- | --- | --- | --- | +| ✅ | ❌ | ✅ | ✅ | ✅ | ✅ | ✅ | + +## Parameters + +### Inputs + +- `firefox-version`: *(Optional)* The Firefox version to install and use. + Default: `latest` + +### Outputs + +- `firefox-version`: The installed Firefox version. Useful when given a latest version. +- `firefox-path`: The installed Firefox path. + ## Contributing See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup, workflow, and release process. From 57c5941e8a5f617d6392343ef3b4e080f31bce13 Mon Sep 17 00:00:00 2001 From: Shin'ya Ueoka Date: Sat, 9 May 2026 23:07:26 +0900 Subject: [PATCH 2/2] docs: add download source to supported version formats table Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f7e17d0..89de068 100644 --- a/README.md +++ b/README.md @@ -43,10 +43,13 @@ jobs: ### Supported version formats -The action supports the following version formats: +| Version format | Example | Download source | +| --- | --- | --- | +| Release channel | `latest` (default), `latest-beta`, `latest-devedition`, `latest-nightly`, `latest-esr` | [Mozilla Releases][] | +| Specific version | `84.0`, `84.0.1`, `beta-84.0b1`, `devedition-84.0b1` | [Mozilla FTP][] | -- Release channels: `latest` (default), `latest-beta`, `latest-devedition`, `latest-nightly`, `latest-esr` -- Specific release version: `84.0`, `84.0.1`, `beta-84.0b1`, `devedition-84.0b1` +[Mozilla Releases]: https://download.mozilla.org/ +[Mozilla FTP]: https://ftp.mozilla.org/pub/firefox/releases/ ## Supported platforms