Skip to content

Commit 26d8240

Browse files
committed
docs: add workflow file paths, clarify draft release behavior
1 parent c783499 commit 26d8240

1 file changed

Lines changed: 11 additions & 1 deletion

File tree

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ your submissions pass on the first try.
1212

1313
### PR Checks (CI)
1414

15+
Create a file at `.github/workflows/ci.yml`:
16+
1517
```yaml
1618
name: CI
1719
on:
@@ -33,6 +35,8 @@ The action auto-detects whether your project is a plugin or theme.
3335
3436
### Release
3537
38+
Create a file at `.github/workflows/release.yml`:
39+
3640
```yaml
3741
name: Release
3842
on:
@@ -59,7 +63,11 @@ jobs:
5963
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
6064
```
6165

62-
Or use the reusable release workflow for a single-file setup:
66+
This creates a **draft release** — after the workflow completes, go to your
67+
repository's Releases page to review and publish it.
68+
69+
Or use the reusable release workflow for a single-file setup at
70+
`.github/workflows/release.yml`:
6371

6472
```yaml
6573
name: Release
@@ -76,6 +84,8 @@ jobs:
7684
attestations: write
7785
```
7886

87+
This also creates a draft release that you need to manually publish.
88+
7989
## Inputs
8090

8191
| Input | Default | Description |

0 commit comments

Comments
 (0)