From 4ed9b9372f8874377300074de4ec749e4976875e Mon Sep 17 00:00:00 2001 From: Michael Rapp Date: Sun, 17 Nov 2024 17:42:54 +0100 Subject: [PATCH] Update documentation. --- doc/developer_guide/coding_standards.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/doc/developer_guide/coding_standards.md b/doc/developer_guide/coding_standards.md index 2902c496b..25b2b67d8 100644 --- a/doc/developer_guide/coding_standards.md +++ b/doc/developer_guide/coding_standards.md @@ -47,8 +47,28 @@ The project's build system allows to automatically check for outdated GitHub Act ``` ```` +Alternatively, the following command may be used to update the versions of outdated Actions automatically: + +````{tab} Linux + ```text + ./build update_github_actions + ``` +```` + +````{tab} macOS + ```text + ./build update_github_actions + ``` +```` + +````{tab} Windows + ``` + build.bat update_github_actions + ``` +```` + ```{note} -The above command queries the [GitHub API](https://docs.github.com/rest) for the latest version of relevant GitHub Actions. You can optionally specify an [API token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) to be used for these queries via the command line argument `GITHUB_TOKEN`. If no token is provided, repeated requests may be prohibited due to GitHub's rate limit. +The above commands query the [GitHub API](https://docs.github.com/rest) for the latest version of relevant GitHub Actions. You can optionally specify an [API token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) to be used for these queries via the environment variable `GITHUB_TOKEN`. If no token is provided, repeated requests might fail due to GitHub's rate limit. ``` (testing)=