Skip to content

Commit 1b63e9b

Browse files
committed
README: add warning about tags needing to start with v
This is a best practice thingie related to Dependabot updates and such for action runner references. Includes allowing for [GitHub flavoured Markdown "alerts"](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts) in the README.
1 parent 9d51cbe commit 1b63e9b

File tree

2 files changed

+15
-1
lines changed

2 files changed

+15
-1
lines changed

.remarkrc

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,18 @@
2020
"remark-lint-no-reference-like-url",
2121
"remark-lint-no-shortcut-reference-image",
2222
"remark-lint-no-table-indentation",
23-
"remark-lint-no-undefined-references",
23+
[
24+
"remark-lint-no-undefined-references",
25+
{
26+
"allow": [
27+
"!NOTE",
28+
"!TIP",
29+
"!IMPORTANT",
30+
"!WARNING",
31+
"!CAUTION"
32+
]
33+
}
34+
],
2435
"remark-lint-no-unneeded-full-reference-image",
2536
"remark-lint-no-unneeded-full-reference-link",
2637
"remark-lint-no-unused-definitions",

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,9 @@ This has two benefits:
6666
2. **Security**
6767
With commit-hash pinned workflows, the dependencies used are fixed to specific versions and updates are managed, which means that it is more difficult for an attacker to be able to infiltrate the workflow runs and get access to secrets and/or cause other havoc.
6868

69+
> [!IMPORTANT]
70+
> It is best practice for tags for repositories which will be used in GitHub Actions workflows to be prefixed with `v` before the version number, so tags in this repository should start with a `v` prefix too.
71+
6972

7073
[community health files]: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file
7174

0 commit comments

Comments
 (0)