Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(github): Auto tag Dev Rel on doc-changing PRs #4375

Merged
merged 3 commits into from
Feb 15, 2024

Conversation

Savio-Sou
Copy link
Collaborator

@Savio-Sou Savio-Sou commented Feb 14, 2024

Description

Problem*

Documentation-changing PRs do not currently notify @noir-lang/developerrelations, which the team prefers (let me know below if that is not actually the case).

Summary*

Extend the documentation preview action to auto-comment and tag @noir-lang/developerrelations on doc-changing PRs.

Preview of how it looks: Savio-Sou#3 (comment)

Documentation*

Check one:

  • No documentation needed.
  • Documentation included in this PR.
  • [Exceptional Case] Documentation to be submitted in a separate PR.

PR Checklist*

  • I have tested the changes locally.
  • I have formatted the changes with Prettier and/or cargo fmt on default settings.

@Savio-Sou Savio-Sou added enhancement New feature or request CI labels Feb 14, 2024
@Savio-Sou Savio-Sou requested a review from a team February 14, 2024 17:59
@TomAFrench TomAFrench added the documentation Improvements or additions to documentation label Feb 14, 2024
Copy link
Contributor

github-actions bot commented Feb 14, 2024

Copy link
Contributor

FYI @noir-lang/developerrelations on Noir doc changes.

@iAmMichaelConnor
Copy link
Collaborator

Maybe you've considered this already, but I believe GitHub recognises a CODEOWNERS file which can achieve a similar outcome, iiuc

@Savio-Sou
Copy link
Collaborator Author

Thanks @iAmMichaelConnor. The intention here is to inform but not necessarily request reviews from Dev Rel on doc-changing PRs, hence I didn't opt for the CODEOWNERS approach.

@Savio-Sou Savio-Sou added this pull request to the merge queue Feb 15, 2024
Merged via the queue into master with commit aeb3241 Feb 15, 2024
41 checks passed
@Savio-Sou Savio-Sou deleted the ss/doc-preview-devrel-tag branch February 15, 2024 12:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants