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/src/firmware-action/change_detection.md
+9-5Lines changed: 9 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,21 +1,21 @@
1
1
# Change detection
2
2
3
-
firmware-action has basic detection of changes.
3
+
`firmware-action` has basic detection of changes.
4
4
5
5
Related temporary files to aid in change detection are stored in `.firmware-action/` directory, which is always created in current working directory.
6
6
7
7
```admonish note
8
8
It is save to delete the `.firmware-action/` directory, but keep in mind that change detection depends on its existence.
9
9
10
-
If `.firmware-action/` directory is deleted, it will be re-created on next firmware-action execution.
10
+
If `.firmware-action/` directory is deleted, it will be re-created on next `firmware-action` execution.
11
11
12
12
It might be advantageous to also include this directory in caches / artifacts when in CI. Preserving these files might reduce run time in the CI.
13
13
```
14
14
15
15
16
16
## Sources modification time
17
17
18
-
When building a module, firmware-action checks recursively all sources for a given module. For all module types, list of sources include repository and all input files.
18
+
When building a module, `firmware-action` checks recursively all sources for a given module. For all module types, list of sources include repository and all input files.
19
19
20
20
```admonish example collapsible=true title="Code snippet: Common sources"
21
21
~~~golang
@@ -37,9 +37,13 @@ On next run, this file (if exists) is loaded with time stamp of last successful
37
37
38
38
## Configuration file changes
39
39
40
-
Firmware-action can also detect changes in the configuration file. For each module, on each successful build, it stores a copy of the configuration in `.firmware-action/configs/` directory. On next run, current configuration is compared to configuration of last successful build, and if the configuration for the specific module differs, module is re-built.
40
+
`firmware-action` can also detect changes in the configuration file. For each module, on each successful build, it stores a copy of the configuration in `.firmware-action/configs/` directory.
41
+
42
+
On next run, current configuration is compared to configuration of last successful build, and if the configuration for the specific module differs, module is re-built.
41
43
42
44
43
45
## Git commit hash changes
44
46
45
-
`firmware-action` can detect changes based on git commit hashes. For each module, on each successful build, it stores the git commit hash of the module's repository path (`repo_path`) in `.firmware-action/git-hash/` directory. On next run, the current git commit hash of the module's repository is compared to the stored hash from the last successful build. If the hashes differ, indicating that the module's repository has been changed, the module is re-built.
47
+
`firmware-action` can detect changes based on git commit hashes. For each module, on each successful build, it stores the git commit hash of the module's repository path (`repo_path`) in `.firmware-action/git-hash/` directory.
48
+
49
+
On next run, the current git commit hash of the module's repository is compared to the stored hash from the last successful build. If the hashes differ, indicating that the module's repository has been changed, the module is re-built.
0 commit comments