Skip to content

Commit 1b6be8d

Browse files
authored
docs: make the first-run workflow path explicit
Co-authored-by: Mresyzz <Mresyzz@users.noreply.github.com>
1 parent 2fee98c commit 1b6be8d

1 file changed

Lines changed: 6 additions & 13 deletions

File tree

‎README.md‎

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@
1818
It is designed for shell testing, portable shell validation, Bash/POSIX compatibility checks, and cross-distro CI where syntax-only tooling is not enough.
1919

2020
If your repository contains an installer, bootstrap script, or shell entrypoint, the fastest path is to
21-
copy the [zero-configuration workflow](.github/workflow-templates/opsscript-gate.yml). It only runs when
22-
shell files change, uses offline containers by default, and uploads a report that can be attached to a PR.
23-
No account, API key, or service signup is required.
21+
open the [InstallReady scanner](https://mresyzz.github.io/InstallReady/), enter `owner/repository`, and
22+
choose **Add workflow on GitHub**. It generates a reviewable workflow without an account, API key, or
23+
service signup. You can also copy the maintained [zero-configuration workflow](.github/workflow-templates/opsscript-gate.yml).
2424

2525
Try the browser scanner: [InstallReady](https://mresyzz.github.io/InstallReady/?repo=Mresyzz%2Fopsscript-gate) checks this repository without executing code or requiring a login.
2626

@@ -56,8 +56,9 @@ See [configuration and migration](docs/configuration.md) and
5656

5757
Add this workflow to `.github/workflows/shell-compat.yml`:
5858

59-
You can also select **OpsScript Gate shell compatibility** from GitHub's workflow templates, or copy the
60-
maintained [starter workflow](.github/workflow-templates/opsscript-gate.yml).
59+
The repository includes a maintained [workflow template](.github/workflow-templates/opsscript-gate.yml).
60+
For a one-click setup in another public repository, use the InstallReady scanner above; it opens GitHub's
61+
workflow editor with the generated file ready to review.
6162

6263
You can copy the maintained example from [`examples/github-actions/workflow.yml`](examples/github-actions/workflow.yml)
6364
and change the `script-path`, or use the minimal workflow below.
@@ -383,14 +384,6 @@ usage: opsscript-gate run [-h] [--matrix MATRIX] [-j JOBS] [--timeout TIMEOUT]
383384
Explicit CLI options override project settings. Explicit script paths bypass discovery
384385
and its exclusions. See [complete configuration semantics](docs/configuration.md).
385386

386-
## Downstream example
387-
388-
[`Mresyzz/linux-dev-bootstrap`](https://github.com/Mresyzz/linux-dev-bootstrap) contains a workflow that validates `install.sh` across the default Debian, Ubuntu, and Alpine matrix.
389-
390-
See the downstream workflow: [`.github/workflows/test.yml`](https://github.com/Mresyzz/linux-dev-bootstrap/blob/main/.github/workflows/test.yml).
391-
392-
---
393-
394387
## 🧪 Development & Testing
395388

396389
```bash

0 commit comments

Comments
 (0)