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
The assets collected in this repository are designed to be as universally applicable as is practical.
However, in some cases it is necessary to make some project-specific configurations within the asset files during the
installation. These locations are indicated by "TODO"-prefixed comments where possible and the location where the
configuration value is to be filled is indicated by placeholder text. I have found that it is sometimes easy to miss
placeholders among a sea of visually similar variable names both while installing and while reviewing installations made
by others.
Adding a `TODO_` prefix to the descriptive suffix of the placeholder text will make it easy for the installer to find
all places where configuration is needed by a quick text search for "TODO" (which will now find both the comments and
placeholders) and also make it easy for the reviewer to spot placeholders the installer missed.
Copy file name to clipboardExpand all lines: workflow-templates/README.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ A collection of reusable [GitHub Actions workflows](https://docs.github.com/acti
4
4
5
5
## Documentation
6
6
7
-
While some workflows can be added to any repository without any modification, others need to be configured for each project. "TODO" comments in the workflow explain what needs to be done. Documentation for each workflow is provided by the .md file of the same name, including:
7
+
While some workflows can be added to any repository without any modification, others need to be configured for each project. "TODO" comments in the workflow explain what needs to be done and `TODO_*` placeholders indicate where project-specific information needs to be filled in. Documentation for each workflow is provided by the .md file of the same name, including:
8
8
9
9
- Instructions
10
10
- List of asset files which must be added to the repository along with the workflow
Replace the `REPO_OWNER` and `REPO_NAME` placeholders in the URLs with the final repository owner and name ([example](https://raw.githubusercontent.com/arduino-libraries/ArduinoIoTCloud/master/README.md)).
36
+
Replace the `TODO_REPO_OWNER` and `TODO_REPO_NAME` placeholders in the URLs with the final repository owner and name ([example](https://raw.githubusercontent.com/arduino-libraries/ArduinoIoTCloud/master/README.md)).
[](https://github.com/REPO_OWNER/REPO_NAME/actions/workflows/check-general-formatting-task.yml)
34
+
[](https://github.com/TODO_REPO_OWNER/TODO_REPO_NAME/actions/workflows/check-general-formatting-task.yml)
35
35
```
36
36
37
-
Replace the `REPO_OWNER` and `REPO_NAME` placeholders in the URLs with the final repository owner and name ([example](https://raw.githubusercontent.com/arduino-libraries/ArduinoIoTCloud/master/README.md)).
37
+
Replace the `TODO_REPO_OWNER` and `TODO_REPO_NAME` placeholders in the URLs with the final repository owner and name ([example](https://raw.githubusercontent.com/arduino-libraries/ArduinoIoTCloud/master/README.md)).
Copy file name to clipboardExpand all lines: workflow-templates/check-go-dependencies-task.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -70,10 +70,10 @@ In this case, the dependency's identifier must be added to the `reviewed.<source
70
70
Markdown badge:
71
71
72
72
```markdown
73
-
[](https://github.com/REPO_OWNER/REPO_NAME/actions/workflows/check-go-dependencies-task.yml)
73
+
[](https://github.com/TODO_REPO_OWNER/TODO_REPO_NAME/actions/workflows/check-go-dependencies-task.yml)
74
74
```
75
75
76
-
Replace the `REPO_OWNER` and `REPO_NAME` placeholders in the URLs with the final repository owner and name ([example](https://raw.githubusercontent.com/arduino-libraries/ArduinoIoTCloud/master/README.md)).
76
+
Replace the `TODO_REPO_OWNER` and `TODO_REPO_NAME` placeholders in the URLs with the final repository owner and name ([example](https://raw.githubusercontent.com/arduino-libraries/ArduinoIoTCloud/master/README.md)).
Copy file name to clipboardExpand all lines: workflow-templates/check-go-task.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -32,10 +32,10 @@ If the project contains Go modules in paths other than the root of the repositor
32
32
Markdown badge:
33
33
34
34
```markdown
35
-
[](https://github.com/REPO_OWNER/REPO_NAME/actions/workflows/check-go-task.yml)
35
+
[](https://github.com/TODO_REPO_OWNER/TODO_REPO_NAME/actions/workflows/check-go-task.yml)
36
36
```
37
37
38
-
Replace the `REPO_OWNER` and `REPO_NAME` placeholders in the URLs with the final repository owner and name ([example](https://raw.githubusercontent.com/arduino-libraries/ArduinoIoTCloud/master/README.md)).
38
+
Replace the `TODO_REPO_OWNER` and `TODO_REPO_NAME` placeholders in the URLs with the final repository owner and name ([example](https://raw.githubusercontent.com/arduino-libraries/ArduinoIoTCloud/master/README.md)).
Replace the `REPO_OWNER` and `REPO_NAME` placeholders in the URLs with the final repository owner and name ([example](https://raw.githubusercontent.com/arduino-libraries/ArduinoIoTCloud/master/README.md)).
26
+
Replace the `TODO_REPO_OWNER` and `TODO_REPO_NAME` placeholders in the URLs with the final repository owner and name ([example](https://raw.githubusercontent.com/arduino-libraries/ArduinoIoTCloud/master/README.md)).
0 commit comments