ci: fix doc check

[moabu]

Prepare

• Read PR guidelines
• Read license information

---

Description

Target issue

closes #9021

Implementation Details

---

Test and Document the changes

• Static code analysis has been run locally and issues have been fixed
• Relevant unit and integration tests have been added/updated
• Relevant documentation has been updated if any (i.e. user guides, installation and configuration guides, technical design docs etc)

Please check the below before submitting your PR. The PR will not be merged if there are no commits that start with docs: to indicate documentation changes or if the below checklist is not selected.

• I confirm that there is no impact on the docs due to the code changes in this PR.

[dryrunsecurity]

DryRun Security Summary

The GitHub Pull Request focuses on improving the documentation review process by modifying the script to extract the commit message, simplify the headline check, and ensure that changes related to documentation start with "docs", while also emphasizing the importance of keeping the third-party dependencies and the use of the GITHUB_TOKEN secure.

Expand for full summary

Summary:

The code changes in this GitHub Pull Request are focused on improving the documentation review process for pull requests. The changes involve modifying the way the script extracts the commit message from the pull request, simplifying the extraction of the commit message headline and checking if it starts with "docs". This change suggests that the repository has a convention of using commit messages starting with "docs" for changes related to documentation.

From a security perspective, the changes do not appear to introduce any obvious vulnerabilities. However, it's important to ensure that the third-party dependencies used in the workflow, such as the GitHub CLI, are kept up-to-date and secure, as vulnerabilities in these dependencies could potentially impact the security of the workflow. Additionally, the workflow is using the GITHUB_TOKEN environment variable, which provides the GitHub Actions workflow with read and write access to the repository, and it's crucial to ensure that this token is used securely and not exposed in any way.

Files Changed:

• .github/workflows/documenation_check.yml: This file is a GitHub Actions workflow configuration file that checks if the pull request contains a commit message starting with "docs". If the commit message does not start with "docs", the workflow checks if the pull request body contains a specific checklist item confirming that the changes do not impact the documentation. The code changes involve modifying the way the script extracts the commit message from the pull request, simplifying the extraction of the commit message headline and checking if it starts with "docs".

Code Analysis

We ran 9 analyzers against 1 file and 0 analyzers had findings. 9 analyzers had no findings.

Riskiness

🟢 Risk threshold not exceeded.

View PR in the DryRun Dashboard.