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.

Sign up for GitHub

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

Jump to bottom

chore(ci): Apply doc needed label automatically on PRs #733

Merged
merged 3 commits into from
Feb 3, 2023
Merged

chore(ci): Apply doc needed label automatically on PRs #733

merged 3 commits into from
Feb 3, 2023

Conversation

Savio-Sou
Copy link
Collaborator

@Savio-Sou Savio-Sou commented Feb 2, 2023 •
edited
Loading

Related issue(s)

Resolves #597

Description

Summary of changes

  • Add Labeler that's triggered upon PR opens & edits at .github/workflows/labeler.yml. Can be extended to also cover Issues down the road.
  • Add Labeler config at .github/labeler.yml.
  • Add triggering task list checkbox in PR template.

Sample PR: https://github.com/Globallager/noir/pull/4

Checklist

  • I have tested the changes locally.
  • I have formatted the changes with Prettier and/or cargo fmt with default settings.
  • I have linked this PR to the issue(s) that it resolves.
  • I have reviewed the changes on GitHub, line by line.
  • I have ensured all changes are covered in the description.

Additional context

Things to do by repo admin after merging cc @kevaundray:

  • Add a new label "doc needed" to this repo (open to name suggestions below).
  • [Optional] Install Slack app to this repo --> enable label notifications on Slack

To subscribe for label notifications on Slack:

  1. Add GitHub's bot to Slack DM / channel
  2. Message the bot with /github subscribe noir-lang/noir +label:"doc needed"

phated
phated suggested changes Feb 2, 2023
View reviewed changes
Copy link
Contributor

@phated phated left a comment

Choose a reason for hiding this comment

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

This is awesome! I think we should apply it to outside collaborators using forks (but that takes some extra consideration)

.github/workflows/labeler.yml Outdated Show resolved Hide resolved
phated
phated reviewed Feb 2, 2023
View reviewed changes
Copy link
Contributor

@phated phated left a comment

Choose a reason for hiding this comment

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

Here are some suggestions ❤️

.github/workflows/labeler.yml Outdated Show resolved Hide resolved
.github/workflows/labeler.yml Show resolved Hide resolved
.github/workflows/labeler.yml Outdated Show resolved Hide resolved
@Savio-Sou Savio-Sou requested a review from phated February 3, 2023 04:23
@kevaundray
Copy link
Contributor

Added the. "doc needed" label

phated
phated approved these changes Feb 3, 2023
View reviewed changes
Copy link
Contributor

@phated phated left a comment

Choose a reason for hiding this comment

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

LGTM 🎉

@phated phated changed the title chore(github): Add PR Labeler - doc needed chore(ci): Apply doc needed label automatically on PRs Feb 3, 2023
@phated phated merged commit 2d6b27c into noir-lang:master Feb 3, 2023
TomAFrench added a commit to TomAFrench/noir that referenced this pull request Feb 3, 2023
@TomAFrench
Merge branch 'master' into nargo-execute
bd4f7c0 
* master:
  feat(nargo): Add `nargo test` command to run all unit tests (noir-lang#728)
  chore(ci): Apply `doc needed` label automatically on PRs (noir-lang#733)
  chore(ci): Remove failing bors workflow (noir-lang#744)
  feat(ci): Add workflow to validate PR title (noir-lang#730)
  feat(docs): Introduce Conventional Commits & release process docs (noir-lang#717)
TomAFrench added a commit that referenced this pull request Feb 3, 2023
@TomAFrench
Merge branch 'master' into nargo-execute
58cf912 
* master:
  feat(nargo): Add `nargo test` command to run all unit tests (#728)
  chore(ci): Apply `doc needed` label automatically on PRs (#733)
  chore(ci): Remove failing bors workflow (#744)
  feat(ci): Add workflow to validate PR title (#730)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@phated phated phated approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add visibility for PRs that change public facing documentation
3 participants
@Savio-Sou @kevaundray @phated