Skip to content

Commit c56b2c4

Browse files
authored
docs: Add build step warning to contributing guide (#9666)
1 parent 73380fb commit c56b2c4

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

CONTRIBUTING.md

+8-5
Original file line numberDiff line numberDiff line change
@@ -500,11 +500,14 @@ If the commit reverts a previous commit, use the prefix `revert:`, followed by t
500500
501501
Fixes for security vulnerabilities are developed in private forks with a closed audience, inaccessible to the public. A current GitHub limitation does not allow to run CI tests on pull requests in private forks. Whether a pull requests fully passes all CI tests can only be determined by publishing the fix as a public pull request and running the CI. This means the fix and implicitly information about the vulnerability are made accessible to the public. This increases the risk that a vulnerability fix is published, but then cannot be merged immediately due to a CI issue. To mitigate that risk, before publishing a vulnerability fix, the following tests needs to be run locally and pass:
502502
503-
- `npm run test` (MongoDB)
504-
- `npm run test` (Postgres)
505-
- `npm run madge:circular` (circular dependencies)
506-
- `npm run lint` (Lint)
507-
- `npm run definitions` (Parse Server options definitions)
503+
- `npm run test` to test with MongoDB
504+
- `npm run test:postgres:testonly` to test with Postgres
505+
- `npm run madge:circular` to detect circular dependencies
506+
- `npm run lint` to check lint compliance
507+
- `npm run definitions` to update the Parse Server options definitions
508+
509+
> [!CAUTION]
510+
> It is essential to run `npm run build` *after* switching to a different branch or making a commit and *before* running any tests. Otherwise the tests may run on the build from a different branch or on a build that does not reflect the most recent commits.
508511
509512
#### Environment
510513

0 commit comments

Comments
 (0)