Skip to content

Commit e2f482f

Browse files
committed
Standardize format of placeholders in templates
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.
1 parent 3c5897d commit e2f482f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+129
-128
lines changed

.github/workflows/test-install-script.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ jobs:
2828
env:
2929
PROJECT_OWNER_PLACEHOLDER: arduino # Placeholder value of the PROJECT_OWNER variable in the template script
3030
PROJECT_OWNER: arduino # Replacement value used for the tests
31-
PROJECT_NAME_PLACEHOLDER: TODO # Placeholder value of the PROJECT_NAME variable in the template script
31+
PROJECT_NAME_PLACEHOLDER: TODO_PROJECT_NAME # Placeholder value of the PROJECT_NAME variable in the template script
3232
PROJECT_NAME: arduino-lint # Replacement value used for the tests
3333
SCRIPT_FOLDER: other/installation-script
3434

.markdown-link-check.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"pattern": "^CONTRIBUTING\\.md#building-the-source-code$"
88
},
99
{
10-
"pattern": "/REPO_NAME/"
10+
"pattern": "/TODO_REPO_NAME/"
1111
}
1212
]
1313
}

issue-templates/minimal/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ This is the minimal issue template, applicable to any Arduino tooling project, i
2121

2222
### Configuration
2323

24-
Replace `REPO_OWNER/REPO_NAME` in the `contact_links[0].url` field of `config.yml`.
24+
Replace `TODO_REPO_OWNER/TODO_REPO_NAME` in the `contact_links[0].url` field of `config.yml`.
2525

2626
Add links for any additional relevant resources to the `contact_links[]` field of `config.yml`.
2727

issue-templates/template-choosers/general/config.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
# https://github.com/arduino/tooling-project-assets/blob/main/issue-templates/template-choosers/general/config.yml
33
contact_links:
44
- name: Learn about using this project
5-
# TODO: Replace REPO_OWNER/REPO_NAME with the repository owner and name
6-
url: https://github.com/REPO_OWNER/REPO_NAME#readme
5+
# TODO: Replace TODO_REPO_OWNER/TODO_REPO_NAME with the repository owner and name
6+
url: https://github.com/TODO_REPO_OWNER/TODO_REPO_NAME#readme
77
about: Detailed usage documentation is available here.
88
- name: Support request
99
url: https://forum.arduino.cc/

issue-templates/template-choosers/github-actions/config.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
# https://github.com/arduino/tooling-project-assets/blob/main/issue-templates/template-choosers/github-actions/config.yml
33
contact_links:
44
- name: Learn about using this project
5-
# TODO: Replace REPO_OWNER/REPO_NAME with the repository owner and name
6-
url: https://github.com/REPO_OWNER/REPO_NAME#readme
5+
# TODO: Replace TODO_REPO_OWNER/TODO_REPO_NAME with the repository owner and name
6+
url: https://github.com/TODO_REPO_OWNER/TODO_REPO_NAME#readme
77
about: Detailed usage documentation is available here.
88
- name: Learn about GitHub Actions
99
url: https://docs.github.com/actions

other/installation-script/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@ This shell script does the following:
2626

2727
Set the `PROJECT_NAME` variable in `install.sh` to the project's repository name (e.g., "arduino-cli").
2828

29-
Replace all occurrences of `PRODUCT_NAME` in `installation.md` with the project's product name (e.g., "Arduino CLI").
29+
Replace all occurrences of `TODO_PRODUCT_NAME` in `installation.md` with the project's product name (e.g., "Arduino CLI").
3030

31-
Replace all occurrences of `REPO_NAME` in `installation.md` with the project's repository name (e.g., "arduino-cli").
31+
Replace all occurrences of `TODO_REPO_NAME` in `installation.md` with the project's repository name (e.g., "arduino-cli").
3232

3333
## Commit message
3434

other/installation-script/install.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
# MIT license. See https://github.com/Masterminds/glide/blob/master/LICENSE for more details and copyright notice.
66

77
PROJECT_OWNER="arduino"
8-
PROJECT_NAME="TODO"
8+
PROJECT_NAME="TODO_PROJECT_NAME"
99

1010
# BINDIR represents the local bin location, defaults to ./bin.
1111
EFFECTIVE_BINDIR=""
+27-27
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,42 @@
11
<!-- Source: https://github.com/arduino/tooling-project-assets/blob/main/other/installation-script/installation.md -->
22

3-
Several options are available for installation of PRODUCT_NAME. Instructions for each are provided below:
3+
Several options are available for installation of TODO_PRODUCT_NAME. Instructions for each are provided below:
44

55
## Use the install script
66

77
The script requires `sh`, which is always available on Linux and macOS. `sh` is not available by default on Windows,
88
though it is available as part of [Git for Windows](https://gitforwindows.org/) (Git Bash). If you don't have `sh`
99
available, use the ["Download" installation option](#download).
1010

11-
This script will install the latest version of PRODUCT_NAME to `$PWD/bin`:
11+
This script will install the latest version of TODO_PRODUCT_NAME to `$PWD/bin`:
1212

1313
```
14-
curl -fsSL https://raw.githubusercontent.com/arduino/REPO_NAME/main/etc/install.sh | sh
14+
curl -fsSL https://raw.githubusercontent.com/arduino/TODO_REPO_NAME/main/etc/install.sh | sh
1515
```
1616

1717
If you want to target a different directory, for example `~/local/bin`, set the `BINDIR` environment variable like this:
1818

1919
```
20-
curl -fsSL https://raw.githubusercontent.com/arduino/REPO_NAME/main/etc/install.sh | BINDIR=~/local/bin sh
20+
curl -fsSL https://raw.githubusercontent.com/arduino/TODO_REPO_NAME/main/etc/install.sh | BINDIR=~/local/bin sh
2121
```
2222

23-
If you would like to use the `REPO_NAME` command from any location, install PRODUCT_NAME to a directory already in
24-
your [`PATH`](https://wikipedia.org/wiki/PATH%5F%28variable%29) or add the PRODUCT_NAME installation path to your
23+
If you would like to use the `TODO_REPO_NAME` command from any location, install TODO_PRODUCT_NAME to a directory already in
24+
your [`PATH`](https://wikipedia.org/wiki/PATH%5F%28variable%29) or add the TODO_PRODUCT_NAME installation path to your
2525
`PATH` environment variable.
2626

27-
If you want to download a specific PRODUCT_NAME version, for example `0.9.0` or `nightly-latest`, pass the version
27+
If you want to download a specific TODO_PRODUCT_NAME version, for example `0.9.0` or `nightly-latest`, pass the version
2828
number as a parameter like this:
2929

3030
```
31-
curl -fsSL https://raw.githubusercontent.com/arduino/REPO_NAME/main/etc/install.sh | sh -s 0.9.0
31+
curl -fsSL https://raw.githubusercontent.com/arduino/TODO_REPO_NAME/main/etc/install.sh | sh -s 0.9.0
3232
```
3333

3434
## Download
3535

3636
Pre-built binaries for all the supported platforms are available for download from the links below.
3737

38-
If you would like to use the `REPO_NAME` command from any location, extract the downloaded file to a directory already
39-
in your [`PATH`](https://wikipedia.org/wiki/PATH%5F%28variable%29) or add the PRODUCT_NAME installation path to your
38+
If you would like to use the `TODO_REPO_NAME` command from any location, extract the downloaded file to a directory already
39+
in your [`PATH`](https://wikipedia.org/wiki/PATH%5F%28variable%29) or add the TODO_PRODUCT_NAME installation path to your
4040
`PATH` environment variable.
4141

4242
### Latest release
@@ -48,17 +48,17 @@ in your [`PATH`](https://wikipedia.org/wiki/PATH%5F%28variable%29) or add the PR
4848
| Windows | [32 bit][windows32] | [64 bit][windows64] |
4949
| macOS | | [64 bit][macos] |
5050

51-
[linux64]: https://downloads.arduino.cc/REPO_NAME/REPO_NAME_latest_Linux_64bit.tar.gz
52-
[linux32]: https://downloads.arduino.cc/REPO_NAME/REPO_NAME_latest_Linux_32bit.tar.gz
53-
[linuxarm64]: https://downloads.arduino.cc/REPO_NAME/REPO_NAME_latest_Linux_ARM64.tar.gz
54-
[linuxarm32]: https://downloads.arduino.cc/REPO_NAME/REPO_NAME_latest_Linux_ARMv7.tar.gz
55-
[windows64]: https://downloads.arduino.cc/REPO_NAME/REPO_NAME_latest_Windows_64bit.zip
56-
[windows32]: https://downloads.arduino.cc/REPO_NAME/REPO_NAME_latest_Windows_32bit.zip
57-
[macos]: https://downloads.arduino.cc/REPO_NAME/REPO_NAME_latest_macOS_64bit.tar.gz
51+
[linux64]: https://downloads.arduino.cc/TODO_REPO_NAME/TODO_REPO_NAME_latest_Linux_64bit.tar.gz
52+
[linux32]: https://downloads.arduino.cc/TODO_REPO_NAME/TODO_REPO_NAME_latest_Linux_32bit.tar.gz
53+
[linuxarm64]: https://downloads.arduino.cc/TODO_REPO_NAME/TODO_REPO_NAME_latest_Linux_ARM64.tar.gz
54+
[linuxarm32]: https://downloads.arduino.cc/TODO_REPO_NAME/TODO_REPO_NAME_latest_Linux_ARMv7.tar.gz
55+
[windows64]: https://downloads.arduino.cc/TODO_REPO_NAME/TODO_REPO_NAME_latest_Windows_64bit.zip
56+
[windows32]: https://downloads.arduino.cc/TODO_REPO_NAME/TODO_REPO_NAME_latest_Windows_32bit.zip
57+
[macos]: https://downloads.arduino.cc/TODO_REPO_NAME/TODO_REPO_NAME_latest_macOS_64bit.tar.gz
5858

5959
### Previous versions
6060

61-
These are available from the "Assets" sections on the [releases page](https://github.com/arduino/REPO_NAME/releases).
61+
These are available from the "Assets" sections on the [releases page](https://github.com/arduino/TODO_REPO_NAME/releases).
6262

6363
### Nightly builds
6464

@@ -72,21 +72,21 @@ get the latest nightly build available for the supported platform, use the follo
7272
| Windows | [32 bit][windows32-nightly] | [64 bit][windows64-nightly] |
7373
| macOS | | [64 bit][macos-nightly] |
7474

75-
[linux64-nightly]: https://downloads.arduino.cc/REPO_NAME/nightly/REPO_NAME_nightly-latest_Linux_64bit.tar.gz
76-
[linux32-nightly]: https://downloads.arduino.cc/REPO_NAME/nightly/REPO_NAME_nightly-latest_Linux_32bit.tar.gz
77-
[linuxarm64-nightly]: https://downloads.arduino.cc/REPO_NAME/nightly/REPO_NAME_nightly-latest_Linux_ARM64.tar.gz
78-
[linuxarm32-nightly]: https://downloads.arduino.cc/REPO_NAME/nightly/REPO_NAME_nightly-latest_Linux_ARMv7.tar.gz
79-
[windows64-nightly]: https://downloads.arduino.cc/REPO_NAME/nightly/REPO_NAME_nightly-latest_Windows_64bit.zip
80-
[windows32-nightly]: https://downloads.arduino.cc/REPO_NAME/nightly/REPO_NAME_nightly-latest_Windows_32bit.zip
81-
[macos-nightly]: https://downloads.arduino.cc/REPO_NAME/nightly/REPO_NAME_nightly-latest_macOS_64bit.tar.gz
75+
[linux64-nightly]: https://downloads.arduino.cc/TODO_REPO_NAME/nightly/TODO_REPO_NAME_nightly-latest_Linux_64bit.tar.gz
76+
[linux32-nightly]: https://downloads.arduino.cc/TODO_REPO_NAME/nightly/TODO_REPO_NAME_nightly-latest_Linux_32bit.tar.gz
77+
[linuxarm64-nightly]: https://downloads.arduino.cc/TODO_REPO_NAME/nightly/TODO_REPO_NAME_nightly-latest_Linux_ARM64.tar.gz
78+
[linuxarm32-nightly]: https://downloads.arduino.cc/TODO_REPO_NAME/nightly/TODO_REPO_NAME_nightly-latest_Linux_ARMv7.tar.gz
79+
[windows64-nightly]: https://downloads.arduino.cc/TODO_REPO_NAME/nightly/TODO_REPO_NAME_nightly-latest_Windows_64bit.zip
80+
[windows32-nightly]: https://downloads.arduino.cc/TODO_REPO_NAME/nightly/TODO_REPO_NAME_nightly-latest_Windows_32bit.zip
81+
[macos-nightly]: https://downloads.arduino.cc/TODO_REPO_NAME/nightly/TODO_REPO_NAME_nightly-latest_macOS_64bit.tar.gz
8282

8383
> These links return a `302: Found` response, redirecting to latest generated builds by replacing `latest` with the
8484
> latest available build date, using the format YYYYMMDD (i.e for 2019-08-06 `latest` is replaced with `20190806` )
8585
8686
Checksums for the nightly builds are available at
87-
`https://downloads.arduino.cc/REPO_NAME/nightly/nightly-<DATE>-checksums.txt`
87+
`https://downloads.arduino.cc/TODO_REPO_NAME/nightly/nightly-<DATE>-checksums.txt`
8888

8989
## Build from source
9090

91-
If you're familiar with Golang or if you want to contribute to the project, you will probably build PRODUCT_NAME locally
91+
If you're familiar with Golang or if you want to contribute to the project, you will probably build TODO_PRODUCT_NAME locally
9292
with your Go toolchain. See the ["How to contribute"](CONTRIBUTING.md#building-the-source-code) page for instructions.

workflow-templates/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ A collection of reusable [GitHub Actions workflows](https://docs.github.com/acti
44

55
## Documentation
66

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:
88

99
- Instructions
1010
- List of asset files which must be added to the repository along with the workflow
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
// Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/cobra/docsgen/go.mod
2-
// TODO: replace MODULE_NAME with the project's module name
3-
module MODULE_NAME/docsgen
2+
// TODO: replace TODO_MODULE_NAME with the project's module name
3+
module TODO_MODULE_NAME/docsgen
44

55
go 1.17
66

7-
replace MODULE_NAME => ../
7+
replace TODO_MODULE_NAME => ../
88

99
require (
10-
MODULE_NAME v0.0.0
10+
TODO_MODULE_NAME v0.0.0
1111
github.com/spf13/cobra v1.4.0
1212
)

workflow-templates/assets/cobra/docsgen/main.go

+3-2
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,9 @@ package main
1818
import (
1919
"os"
2020

21-
// TODO: Replace CLI_PACKAGE_NAME with the project's Cobra CLI package import path
22-
cli "CLI_PACKAGE_NAME"
21+
// TODO: Replace TODO_CLI_PACKAGE_NAME with the project's Cobra CLI package import path
22+
cli "TODO_CLI_PACKAGE_NAME"
23+
2324
"github.com/spf13/cobra/doc"
2425
)
2526

workflow-templates/assets/general/gon.config.hcl

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/general/gon.config.hcl
22
# See: https://github.com/mitchellh/gon#configuration-file
3-
source = [TODO]
4-
bundle_id = TODO
3+
source = [TODO_SOURCE_PATH]
4+
bundle_id = TODO_BUNDLE_ID
55

66
sign {
77
application_identity = "Developer ID Application: ARDUINO SA (7KT7ZWMCJT)"

workflow-templates/assets/mkdocs/mkdocs.yml

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/mkdocs/mkdocs.yml
22
# See: https://www.mkdocs.org/user-guide/configuration/
33

4-
# TODO: Fill in all blank fields below.
5-
site_name:
6-
site_description:
7-
site_url:
4+
# TODO: Replace all "TODO_*" placeholders with the project information.
5+
site_name: TODO_SITE_NAME
6+
site_description: TODO_SITE_DESCRIPTION
7+
site_url: TODO_SITE_URL
88

9-
repo_name:
10-
repo_url:
9+
repo_name: TODO_REPO_NAME
10+
repo_url: TODO_REPO_URL
1111
edit_uri: blob/main/docs/
1212

1313
copyright: Copyright 2021 ARDUINO SA (http://www.arduino.cc/)
@@ -34,7 +34,7 @@ markdown_extensions:
3434
emoji_generator: !!python/name:pymdownx.emoji.to_svg
3535
emoji_index: !!python/name:pymdownx.emoji.twemoji
3636
- pymdownx.magiclink:
37-
repo:
37+
repo: TODO_REPO_NAME
3838
repo_url_shorthand: true
3939
user: arduino
4040
- pymdownx.superfences

workflow-templates/assets/test-integration/test_all.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ def run_command(pytestconfig, working_dir) -> typing.Callable[..., invoke.runner
3232
"""
3333

3434
# TODO: define project's executable name here:
35-
executable_path = pathlib.Path(pytestconfig.rootdir).parent / "TODO"
35+
executable_path = pathlib.Path(pytestconfig.rootdir).parent / "TODO_EXECUTABLE_NAME"
3636

3737
def _run(
3838
cmd: list,

workflow-templates/check-certificates.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Install the [`check-certificates.yml`](check-certificates.yml) GitHub Actions wo
1010

1111
### Configuration
1212

13-
Replace `REPO_OWNER/REPO_NAME` with the repository's name in the `jobs.check-certificates.if` field of `check-certificates.yml`.
13+
Replace `TODO_REPO_OWNER/TODO_REPO_NAME` with the repository's name in the `jobs.check-certificates.if` field of `check-certificates.yml`.
1414

1515
#### Set up Slack webhook
1616

@@ -30,10 +30,10 @@ Replace `REPO_OWNER/REPO_NAME` with the repository's name in the `jobs.check-cer
3030
Markdown badge:
3131

3232
```markdown
33-
[![Check Certificates status](https://github.com/REPO_OWNER/REPO_NAME/actions/workflows/check-certificates.yml/badge.svg)](https://github.com/REPO_OWNER/REPO_NAME/actions/workflows/check-certificates.yml)
33+
[![Check Certificates status](https://github.com/TODO_REPO_OWNER/TODO_REPO_NAME/actions/workflows/check-certificates.yml/badge.svg)](https://github.com/TODO_REPO_OWNER/TODO_REPO_NAME/actions/workflows/check-certificates.yml)
3434
```
3535

36-
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)).
3737

3838
---
3939

workflow-templates/check-certificates.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ jobs:
3131
run: |
3232
RELEASE_BRANCH_REGEX="refs/heads/[0-9]+.[0-9]+.x"
3333
# TODO: Update repository name.
34-
REPO_SLUG="REPO_OWNER/REPO_NAME"
34+
REPO_SLUG="TODO_REPO_OWNER/TODO_REPO_NAME"
3535
if [[
3636
(
3737
# Only run on branch creation when it is a release branch.

workflow-templates/check-general-formatting-task.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,10 @@ https://github.com/editorconfig-checker/editorconfig-checker#configuration
3131
Markdown badge:
3232

3333
```markdown
34-
[![Check General Formatting status](https://github.com/REPO_OWNER/REPO_NAME/actions/workflows/check-general-formatting-task.yml/badge.svg)](https://github.com/REPO_OWNER/REPO_NAME/actions/workflows/check-general-formatting-task.yml)
34+
[![Check General Formatting status](https://github.com/TODO_REPO_OWNER/TODO_REPO_NAME/actions/workflows/check-general-formatting-task.yml/badge.svg)](https://github.com/TODO_REPO_OWNER/TODO_REPO_NAME/actions/workflows/check-general-formatting-task.yml)
3535
```
3636

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)).
3838

3939
---
4040

workflow-templates/check-go-dependencies-task.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -70,10 +70,10 @@ In this case, the dependency's identifier must be added to the `reviewed.<source
7070
Markdown badge:
7171

7272
```markdown
73-
[![Check Go Dependencies status](https://github.com/REPO_OWNER/REPO_NAME/actions/workflows/check-go-dependencies-task.yml/badge.svg)](https://github.com/REPO_OWNER/REPO_NAME/actions/workflows/check-go-dependencies-task.yml)
73+
[![Check Go Dependencies status](https://github.com/TODO_REPO_OWNER/TODO_REPO_NAME/actions/workflows/check-go-dependencies-task.yml/badge.svg)](https://github.com/TODO_REPO_OWNER/TODO_REPO_NAME/actions/workflows/check-go-dependencies-task.yml)
7474
```
7575

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)).
7777

7878
---
7979

workflow-templates/check-go-task.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,10 @@ If the project contains Go modules in paths other than the root of the repositor
3232
Markdown badge:
3333

3434
```markdown
35-
[![Check Go status](https://github.com/REPO_OWNER/REPO_NAME/actions/workflows/check-go-task.yml/badge.svg)](https://github.com/REPO_OWNER/REPO_NAME/actions/workflows/check-go-task.yml)
35+
[![Check Go status](https://github.com/TODO_REPO_OWNER/TODO_REPO_NAME/actions/workflows/check-go-task.yml/badge.svg)](https://github.com/TODO_REPO_OWNER/TODO_REPO_NAME/actions/workflows/check-go-task.yml)
3636
```
3737

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)).
3939

4040
---
4141

workflow-templates/check-license.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ Install the [`check-license.yml`](check-license.yml) GitHub Actions workflow to
2020
Markdown badge:
2121

2222
```markdown
23-
[![Check License status](https://github.com/REPO_OWNER/REPO_NAME/actions/workflows/check-license.yml/badge.svg)](https://github.com/REPO_OWNER/REPO_NAME/actions/workflows/check-license.yml)
23+
[![Check License status](https://github.com/TODO_REPO_OWNER/TODO_REPO_NAME/actions/workflows/check-license.yml/badge.svg)](https://github.com/TODO_REPO_OWNER/TODO_REPO_NAME/actions/workflows/check-license.yml)
2424
```
2525

26-
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)).
2727

2828
---
2929

0 commit comments

Comments
 (0)