Skip to content

Commit d0564b1

Browse files
authored
docs: modify contributing to exclude Windows for action rebuild (cypress-io#1669)
1 parent 664c54f commit d0564b1

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,15 @@ To contribute changes, follow these instructions in the order given below:
7575

7676
#### Windows users
7777

78-
The repository is set up with a `git` / `Husky` pre-commit hook which ensures that any changes to the core source files are formatted and built consistently before they are committed. This does not work well with [GitHub Desktop](https://docs.github.com/en/desktop). You can disable this function by setting an environment variable `HUSKY=0`. If you do this and then omit to use `npm run format` / `npm run build` before you commit any changes affecting the core source files, you will find that checks fail when you submit a PR. In this case you should run the `format` and `build` commands and amend your commit.
78+
Rebuilding the action with `npm run build` produces different results under Windows compared to Ubuntu.
79+
This means that Windows cannot be used to rebuild the action,
80+
because the workflow [check-dist.yml](./.github/workflows/check-dist.yml), running under `ubuntu-24.04`,
81+
will fail for action content in the [dist](./dist/) directory built under Windows.
82+
83+
The repository is set up with a `git` / `Husky` pre-commit hook which is intended to ensure that any changes
84+
to the core source files are formatted and built consistently before they are committed.
85+
Since this is not relevant for Windows, you can disable this function by setting an environment variable `HUSKY=0`.
86+
You can alternatively use `git commit` with `--no-verify` to bypass the pre-commit hook from `Husky` when working on Windows.
7987

8088
### Adding a new example
8189

0 commit comments

Comments
 (0)