Skip to content

Commit 501e970

Browse files
committed
Add some docs about running locally.
1 parent e3062e9 commit 501e970

1 file changed

Lines changed: 23 additions & 0 deletions

File tree

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,29 @@ npm run test:php -- --filter <test name>
9797
npm run test:php -- --group <group name or ticket number>
9898
```
9999

100+
#### To lint the workflow files
101+
102+
GitHub Actions workflows operate in a privileged software supply chain environment, therefore the workflow files must be adhere to a high degree of quality and security standards.
103+
104+
The YAML workflow files in the `.github/workflows` directory are statically scanned during GitHub Actions workflow runs using [Actionlint](https://github.com/rhysd/actionlint) and [Zizmor](https://github.com/zizmorcore/zizmor). If you're making changes to those files then you can install both these tools locally using a package manager for your operating system and then run them to lint the files.
105+
106+
- [Actionlint installations instructions](https://github.com/rhysd/actionlint/blob/main/docs/install.md)
107+
- [Zizmor installation instructions](https://docs.zizmor.sh/installation/)
108+
109+
To run Actionlint:
110+
111+
```
112+
actionlint
113+
```
114+
115+
To run Zizmor (note the trailing period):
116+
117+
```
118+
zizmor .
119+
```
120+
121+
The linting that happens during GitHub Actions workflow runs is connected to GitHub Code Scanning, so linting errors won't cause workflow runs to fail directly. Some linting issues that are reported locally may be ignored in the Code Scanning settings.
122+
100123
#### Generating a code coverage report
101124
PHP code coverage reports are [generated daily](https://github.com/WordPress/wordpress-develop/actions/workflows/test-coverage.yml) and [submitted to Codecov.io](https://app.codecov.io/gh/WordPress/wordpress-develop).
102125

0 commit comments

Comments
 (0)