ci: add docs check to make sure every PR is doc checked

[moabu]

Prepare

• Read PR guidelines
• Read license information

---

Description

Target issue

closes #8841

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)

Closes #8843,

[dryrunsecurity]

Hi there 👋, @DryRunSecurity here, below is a summary of our analysis and findings.

DryRun Security	Status	Findings
Server-Side Request Forgery Analyzer	✅	0 findings
Configured Codepaths Analyzer	✅	0 findings
Secrets Analyzer	✅	0 findings
Authn/Authz Analyzer	✅	0 findings
SQL Injection Analyzer	✅	0 findings
Sensitive Files Analyzer	✅	0 findings
IDOR Analyzer	✅	0 findings

Note

🟢 Risk threshold not exceeded.

Change Summary (click to expand)

The following is a summary of changes in this pull request made by me, your security buddy 🤖. Note that this summary is auto-generated and not meant to be a definitive list of security issues but rather a helpful summary from a security perspective.

Summary:

The provided changes focus on the implementation of a pull request (PR) template and a GitHub Actions workflow to ensure that documentation changes are properly identified and communicated in the PR process.

The PR template includes several security-related checklist items, such as verifying that relevant unit and integration tests have been added or updated, and confirming that there is no impact on the documentation due to the code changes. These practices help maintain the security and integrity of the codebase.

The GitHub Actions workflow is designed to automatically check for documentation changes in pull requests. It verifies the commit message and the PR body to ensure that the PR author has acknowledged any documentation changes. This workflow helps to identify and manage sensitive information that may be present in the documentation, which is an important security consideration.

Overall, these changes demonstrate a proactive approach to maintaining the security and quality of the project's codebase and documentation. The inclusion of security-focused checklist items and the automated workflow for documentation changes are positive steps towards enhancing the overall security posture of the application.

Files Changed:

1. .github/pull_request_template.md:

   • This file contains the pull request template for the Janssen Project repository.
   • The template includes several checklist items related to security, such as ensuring relevant tests have been added/updated and confirming that there is no impact on the documentation.
   • These practices help maintain the security and integrity of the codebase.

2. .github/workflows/documenation_check.yml:

   • This GitHub Actions workflow is designed to check for documentation changes in pull requests.
   • The workflow is triggered when a new PR is opened or edited and verifies the commit message and PR body to ensure that the PR author has acknowledged any documentation changes.
   • This workflow helps to identify and manage sensitive information that may be present in the documentation, which is an important security consideration.

Powered by DryRun Security

[mo-auto]

Error: Hi @moabu, You did not reference an open issue in your PR. I attempted to create an issue for you.
Please update that issues' title and body and make sure I correctly referenced it in the above PRs body.