Skip to content

Commit 7e0c883

Browse files
committed
Update URLs in workflow reference comments
The GitHub Actions workflows contain some comments that provide references to more information about parts that might not be clear to maintainers or contributors. Some small improvements are hereby made to these URLs, including enabling localization.
1 parent f84e453 commit 7e0c883

10 files changed

+17
-17
lines changed

.github/workflows/check-general-formatting-task.yml

Lines changed: 3 additions & 3 deletions
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/check-general-formatting-task.md
22
name: Check General Formatting
33

4-
# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows
4+
# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
55
on:
66
push:
77
pull_request:
@@ -18,7 +18,7 @@ jobs:
1818
steps:
1919
- name: Set environment variables
2020
run: |
21-
# See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable
21+
# See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#setting-an-environment-variable
2222
echo "EC_INSTALL_PATH=${{ runner.temp }}/editorconfig-checker" >> "$GITHUB_ENV"
2323
2424
- name: Checkout repository
@@ -46,7 +46,7 @@ jobs:
4646
# Give the binary a standard name
4747
mv "${{ env.EC_INSTALL_PATH }}/bin/ec-linux-amd64" "${{ env.EC_INSTALL_PATH }}/bin/ec"
4848
# Add installation to PATH:
49-
# See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#adding-a-system-path
49+
# See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#adding-a-system-path
5050
echo "${{ env.EC_INSTALL_PATH }}/bin" >> "$GITHUB_PATH"
5151
5252
- name: Check formatting

.github/workflows/check-license.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ env:
66
# SPDX identifier: https://spdx.org/licenses/
77
EXPECTED_LICENSE_TYPE: GPL-3.0
88

9-
# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows
9+
# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
1010
on:
1111
push:
1212
paths:

.github/workflows/check-markdown-task.yml

Lines changed: 1 addition & 1 deletion
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/check-markdown-task.md
22
name: Check Markdown
33

4-
# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows
4+
# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
55
on:
66
push:
77
paths:

.github/workflows/check-prettier-formatting-task.yml

Lines changed: 1 addition & 1 deletion
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/check-prettier-formatting-task.md
22
name: Check Prettier Formatting
33

4-
# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows
4+
# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
55
on:
66
push:
77
paths:

.github/workflows/check-shell-task.yml

Lines changed: 5 additions & 5 deletions
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/check-shell-task.md
22
name: Check Shell Scripts
33

4-
# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows
4+
# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
55
on:
66
push:
77
paths:
@@ -50,7 +50,7 @@ jobs:
5050
steps:
5151
- name: Set environment variables
5252
run: |
53-
# See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable
53+
# See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#setting-an-environment-variable
5454
echo "INSTALL_PATH=${{ runner.temp }}/shellcheck" >> "$GITHUB_ENV"
5555
5656
- name: Checkout repository
@@ -77,7 +77,7 @@ jobs:
7777
tar --extract --file="${{ steps.download.outputs.name }}"
7878
EXTRACTION_FOLDER="$(basename "${{ steps.download.outputs.name }}" "${{ env.SHELLCHECK_RELEASE_ASSET_SUFFIX }}")"
7979
# Add installation to PATH:
80-
# See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#adding-a-system-path
80+
# See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#adding-a-system-path
8181
echo "${{ env.INSTALL_PATH }}/$EXTRACTION_FOLDER" >> "$GITHUB_PATH"
8282
8383
- name: Run ShellCheck
@@ -93,7 +93,7 @@ jobs:
9393
steps:
9494
- name: Set environment variables
9595
run: |
96-
# See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable
96+
# See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#setting-an-environment-variable
9797
echo "SHFMT_INSTALL_PATH=${{ runner.temp }}/shfmt" >> "$GITHUB_ENV"
9898
9999
- name: Checkout repository
@@ -121,7 +121,7 @@ jobs:
121121
# Standardize binary name
122122
mv "${{ env.SHFMT_INSTALL_PATH }}/${{ steps.download.outputs.name }}" "${{ env.SHFMT_INSTALL_PATH }}/shfmt"
123123
# Add installation to PATH:
124-
# See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#adding-a-system-path
124+
# See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#adding-a-system-path
125125
echo "${{ env.SHFMT_INSTALL_PATH }}" >> "$GITHUB_PATH"
126126
127127
- name: Format shell scripts

.github/workflows/check-taskfiles.yml

Lines changed: 1 addition & 1 deletion
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/check-taskfiles.md
22
name: Check Taskfiles
33

4-
# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows
4+
# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
55
on:
66
push:
77
paths:

.github/workflows/check-workflows-task.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Source: https://github.com/arduino/tooling-project-assets/blob/master/workflow-templates/check-workflows-task.md
22
name: Check Workflows
33

4-
# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows
4+
# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
55
on:
66
push:
77
paths:

.github/workflows/check-yaml-task.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ env:
55
# See: https://github.com/actions/setup-python/tree/main#available-versions-of-python
66
PYTHON_VERSION: "3.9"
77

8-
# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows
8+
# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
99
on:
1010
push:
1111
paths:

.github/workflows/spell-check-task.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ env:
55
# See: https://github.com/actions/setup-python/tree/main#available-versions-of-python
66
PYTHON_VERSION: "3.9"
77

8-
# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows
8+
# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
99
on:
1010
push:
1111
pull_request:

.github/workflows/sync-labels.yml

Lines changed: 2 additions & 2 deletions
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/sync-labels.md
22
name: Sync Labels
33

4-
# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows
4+
# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
55
on:
66
push:
77
paths:
@@ -86,7 +86,7 @@ jobs:
8686
steps:
8787
- name: Set environment variables
8888
run: |
89-
# See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable
89+
# See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#setting-an-environment-variable
9090
echo "MERGED_CONFIGURATION_PATH=${{ runner.temp }}/labels.yml" >> "$GITHUB_ENV"
9191
9292
- name: Determine whether to dry run

0 commit comments

Comments
 (0)