You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/updating_dependencies.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,27 +10,27 @@ This is a guide to updating project dependencies. Various project dependencies r
10
10
11
11
To update [Electron][electron], perform the following steps:
12
12
13
-
1.[ ]Check the version release notes to ensure that updating [Electron][electron] will **not** introduce breaking changes. Note that a major [Electron][electron] release does **not** imply breaking changes within the project. What matters is what changes are included in the release and whether those changes affect our usage of [Electron][electron].
13
+
1. Check the version release notes to ensure that updating [Electron][electron] will **not** introduce breaking changes. Note that a major [Electron][electron] release does **not** imply breaking changes within the project. What matters is what changes are included in the release and whether those changes affect our usage of [Electron][electron].
14
14
15
15
If updating [Electron][electron]**will** introduce breaking changes, assess the implications to the project and determine whether the changes affect internal project usage or will cause downstream effects for project consumers. If the former, assess whether refactoring to accommodate the changes is possible. In both scenarios, consult with a project lead to determine an update strategy.
16
16
17
-
2.[ ]Update the configuration file found in `/etc` for [David][david], a service which monitors npm for new releases, to use the desired [Electron][electron] version.
17
+
2. Update the configuration file found in `/etc` for [David][david], a service which monitors npm for new releases, to use the desired [Electron][electron] version.
18
18
19
-
3.[ ]Update the default `DEPS_ELECTRON_VERSION` Makefile environment variable value to the desired [Electron][electron] version.
19
+
3. Update the default `DEPS_ELECTRON_VERSION` Makefile environment variable value to the desired [Electron][electron] version.
20
20
21
-
4.[ ]For each [Electron][electron] checksum found in `/deps/checksums`, rename the folder to the desired [Electron][electron] version and update the checksum for each target platform. If [Electron][electron] adds support for a new target platform, add the checksum. If [Electron][electron] removes support for a target platform, remove the existing checksum.
21
+
4. For each [Electron][electron] checksum found in `/deps/checksums`, rename the folder to the desired [Electron][electron] version and update the checksum for each target platform. If [Electron][electron] adds support for a new target platform, add the checksum. If [Electron][electron] removes support for a target platform, remove the existing checksum.
22
22
23
-
5.[ ]Commit the changes.
23
+
5. Commit the changes.
24
24
25
25
## Node Modules
26
26
27
27
To update `node_modules` dependencies, perform the following steps:
28
28
29
-
1.[ ]Check the dependency's release notes, changelog, and/or commit history to ensure that updating the dependency will **not** introduce breaking changes. Note that a major release does **not** imply breaking changes within the project. What matters is what changes are included in the release and whether those changes affect our usage of the dependency.
29
+
1. Check the dependency's release notes, changelog, and/or commit history to ensure that updating the dependency will **not** introduce breaking changes. Note that a major release does **not** imply breaking changes within the project. What matters is what changes are included in the release and whether those changes affect our usage of the dependency.
30
30
31
31
If updating a dependency **will** introduce breaking changes, assess the implications to the project and determine whether the changes affect internal project usage or will cause downstream effects for project consumers. If the former, assess whether refactoring to accommodate the changes is possible. In both scenarios, consult with a project lead to determine an update strategy.
32
32
33
-
2.[ ]Remove the dependency. If the dependency is a production dependency,
33
+
2. Remove the dependency. If the dependency is a production dependency,
34
34
35
35
<!-- run-disable -->
36
36
@@ -48,7 +48,7 @@ To update `node_modules` dependencies, perform the following steps:
48
48
49
49
Note that the above commands will remove the dependency **and** update the root `package.json`.
50
50
51
-
3. [ ] Install the dependency. If the dependency is a production dependency,
51
+
3. Install the dependency. If the dependency is a production dependency,
52
52
53
53
<!-- run-disable -->
54
54
@@ -66,7 +66,7 @@ To update `node_modules` dependencies, perform the following steps:
66
66
67
67
Note that the above commands will install the dependency **and** update the root `package.json`.
0 commit comments