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

PR Labeler: label PRs which update **/README.md as type/docs #11754

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

jswank
Copy link
Contributor

@jswank jswank commented Jan 23, 2024

What this PR does / why we need it:
Ensure that PRs which modify **/README.md are labeled appropriately with the type/docs label. See #11753 for details.

Which issue(s) this PR fixes:
Fixes #11753

Special notes for your reviewer:

Checklist

  • Reviewed the CONTRIBUTING.md guide (required)
  • Documentation added
  • Tests updated
  • CHANGELOG.md updated
    • If the change is worth mentioning in the release notes, add add-to-release-notes label
  • Changes that require user attention or interaction to upgrade are documented in docs/sources/setup/upgrade/_index.md
  • For Helm chart changes bump the Helm chart version in production/helm/loki/Chart.yaml and update production/helm/loki/CHANGELOG.md and production/helm/loki/README.md. Example PR
  • If the change is deprecating or removing a configuration option, update the deprecated-config.yaml and deleted-config.yaml files respectively in the tools/deprecated-config-checker directory. Example PR

@jswank jswank requested a review from a team as a code owner January 23, 2024 17:54
@JStickler
Copy link
Contributor

@jswank I wasn't sure after our exchange of comments on your issue, did you want to move ahead on this PR? I don't approve PRs outside of /docs/sources but I can ask one of the engineers to review/approve this.

@jswank
Copy link
Contributor Author

jswank commented Jan 31, 2024

@JStickler My understanding is that you and docs team are the primary beneficiaries of the PR. If your workflow is improved by labelling PRs updating README.md for review by your team, then moving ahead makes sense. If that is not beneficial to you, then the issue and this PR can be closed.

@JStickler
Copy link
Contributor

@trevorwhitney @jeschkies Tagging you because you were the last ones to update these files.
@periklis Tagging you for visibility as this touches the operator files.

Copy link
Collaborator

@trevorwhitney trevorwhitney left a comment

Choose a reason for hiding this comment

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

don't know a ton about this action, but based on a quick reading of https://github.com/actions/labeler this lgtm!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

PR Labeler: label PRs which update README.md as type/docs
3 participants