Skip to content

[misc] Add docs acknowledgement check#4310

Merged
mlsmaycon merged 3 commits intomainfrom
add-docks-ack-check
Aug 8, 2025
Merged

[misc] Add docs acknowledgement check#4310
mlsmaycon merged 3 commits intomainfrom
add-docks-ack-check

Conversation

@mlsmaycon
Copy link
Collaborator

@mlsmaycon mlsmaycon commented Aug 8, 2025

Describe your changes

Issue ticket number and link

Stack

Checklist

  • Is it a bug fix
  • Is a typo/documentation fix
  • Is a feature enhancement
  • It is a refactor
  • Created tests that fail without the change (if possible)
  • Extended the README / documentation, if necessary

By submitting this pull request, you confirm that you have read and agree to the terms of the Contributor License Agreement.

Documentation

Select exactly one:

  • I added/updated documentation for this change
  • Documentation is not needed for this change (explain why)

Docs PR URL (required if "docs added" is checked)

Paste the PR link from https://github.com/netbirdio/docs here:

https://github.com/netbirdio/docs/pull/____

Copilot AI review requested due to automatic review settings August 8, 2025 15:52

This comment was marked as outdated.

@sonarqubecloud
Copy link

sonarqubecloud bot commented Aug 8, 2025

@braginini braginini requested review from braginini and Copilot August 8, 2025 16:00
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds a GitHub Actions workflow to enforce documentation requirements for pull requests, ensuring contributors acknowledge whether their changes need documentation updates or provide a link to a corresponding docs PR.

  • Adds a new GitHub Actions workflow that validates documentation acknowledgement in PR descriptions
  • Updates the PR template to include mandatory documentation checkboxes and URL field
  • Implements validation logic to ensure exactly one documentation option is selected and verifies docs PR URLs when provided

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
.github/workflows/docs-ack.yml New workflow that validates documentation requirements and verifies docs PR links
.github/pull_request_template.md Added documentation section with checkboxes and URL field for docs PR links
Comments suppressed due to low confidence (1)

.github/workflows/docs-ack.yml:27

  • The placeholder URL ends with '__' (double underscore) instead of the more standard '____' (four underscores) used in the workflow validation pattern.
        run: |

@mlsmaycon mlsmaycon merged commit 0f52144 into main Aug 8, 2025
35 of 36 checks passed
@mlsmaycon mlsmaycon deleted the add-docks-ack-check branch August 8, 2025 16:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants