chore(project): update contributing docs for dependabot (#5953)
Because * We need to manually address security warnings created by dependabot * We need to perform dependabot duty on both mozilla/experimenter and mozilla/experimenter-docs * We can now automatically approve dependabot PRs This commit * Adds instructions to contributing.md for * Addressing security warnings * Addressing dependabot prs in both mozilla/experimenter and mozilla/experimenter-docs * Approving dependabot PRs automatically
This commit is contained in:
Родитель
5cc00614ad
Коммит
71d8081230
|
@ -120,7 +120,8 @@ Just as in the **subject**, use the imperative, present tense: "change" not "cha
|
|||
## Dependency Management
|
||||
Dependencies are automatically updated by [Dependabot](https://dependabot.com/) which is now integrated
|
||||
directly into GitHub. Each week Dependabot will create a large number of individual PRs that update
|
||||
each dependency. To merge those into main, use the following process:
|
||||
each dependency in each of the [Experimenter](https://github.com/mozilla/experimenter) and
|
||||
[Experimenter Docs](https://github.com/mozilla/experimenter-docs) repos. To merge those into the `main` branch, use the following process:
|
||||
|
||||
### Merge Dependabot PRs
|
||||
|
||||
|
@ -144,6 +145,25 @@ make dependabot_approve
|
|||
### Failed Dependabot PRs
|
||||
If a Dependabot PR fails the CI checks you can either investigate the failure and see if it can be resolved quickly/easily, or close it altogether.
|
||||
|
||||
### Security Warnings
|
||||
Dependabot will also produce [Security Advisories](https://github.com/mozilla/experimenter/security/dependabot) for packages that have registered [CVE](https://en.wikipedia.org/wiki/Common_Vulnerabilities_and_Exposures) numbers. These can not be resolved automatically. To resolve the security warnings:
|
||||
|
||||
1. Copy the **Remediation** version from the security warning into the `"resolutions"` section of `app/package.json`, example:
|
||||
|
||||
```js
|
||||
"resolutions": {
|
||||
"postcss": "^7.0.36",
|
||||
```
|
||||
|
||||
1. Update the `yarn.lock` file by running
|
||||
|
||||
```sh
|
||||
yarn install
|
||||
```
|
||||
|
||||
1. Commit your changes in a PR titled `chore(deps): Security <list affected packages>`
|
||||
1. Create a PR and request review
|
||||
1. Merge when approved
|
||||
|
||||
## Continuous Deployment Process
|
||||
When a PR is merged into main it will automatically be deployed to the stage instance and if that
|
||||
|
|
Загрузка…
Ссылка в новой задаче