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

Add PROCESSES document #44

Merged
merged 4 commits into from
Sep 6, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 22 additions & 17 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1,20 +1,25 @@
# See https://github.com/scottrigby/prometheus-helm-charts/issues/12
# https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners
# https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners#codeowners-syntax

charts/prometheus/ @gianrubio @zanhsieh @Xtigyro
charts/prometheus-adapter/ @mattiasgees @steven-sheehy @hectorj2f
charts/prometheus-blackbox-exporter/ @desaintmartin @gianrubio
charts/prometheus-cloudwatch-exporter/ @gianrubio @torstenwalter @asherf
charts/prometheus-consul-exporter @timm088
charts/prometheus-couchdb-exporter @gkarthiks
charts/prometheus-mongodb-exporter @steven-sheehy
charts/prometheus-mysql-exporter @juanchimienti @monotek
charts/prometheus-nats-exporter @okgolove @caarlos0
charts/prometheus-node-exporter @gianrubio @vsliouniaev
charts/prometheus-operator @vsliouniaev @bismarck @gianrubio
charts/prometheus-postgres-exporter @gianrubio
charts/prometheus-pushgateway @gianrubio @cstaud
charts/prometheus-rabbitmq-exporter @juanchimienti
charts/prometheus-redis-exporter @acondrat
charts/prometheus-snmp-exporter @miouge1
charts/prometheus-to-sd @acondrat
# The repo admins team will be the default owners for everything in the repo.
# Unless a later match takes precedence, they will be requested for review when someone opens a pull request.
* @prometheus-community/helm-charts-admins
Copy link
Member

Choose a reason for hiding this comment

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

💯


/charts/prometheus/ @gianrubio @zanhsieh @Xtigyro
Copy link
Member

Choose a reason for hiding this comment

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

Nice catch on the preceding slash. As you said it's unlikely but possible for nested dirs in other charts to have one of these same names. Better to be explicit 👍

/charts/prometheus-adapter/ @mattiasgees @steven-sheehy @hectorj2f
/charts/prometheus-blackbox-exporter/ @desaintmartin @gianrubio
/charts/prometheus-cloudwatch-exporter/ @gianrubio @torstenwalter @asherf
/charts/prometheus-consul-exporter @timm088
/charts/prometheus-couchdb-exporter @gkarthiks
/charts/prometheus-mongodb-exporter @steven-sheehy
/charts/prometheus-mysql-exporter @juanchimienti @monotek
/charts/prometheus-nats-exporter @okgolove @caarlos0
/charts/prometheus-node-exporter @gianrubio @vsliouniaev
/charts/prometheus-operator @vsliouniaev @bismarck @gianrubio
/charts/prometheus-postgres-exporter @gianrubio
/charts/prometheus-pushgateway @gianrubio @cstaud
/charts/prometheus-rabbitmq-exporter @juanchimienti
/charts/prometheus-redis-exporter @acondrat @zanhsieh
Copy link
Member

Choose a reason for hiding this comment

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

Just checking, did @acondrat approve @zanhsieh to co-maintain the prometheus-redos-exporter chart?

Copy link
Member

Choose a reason for hiding this comment

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

yes - #46

/charts/prometheus-snmp-exporter @miouge1
/charts/prometheus-to-sd @acondrat
11 changes: 11 additions & 0 deletions PROCESSES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Processes
Copy link
Member

Choose a reason for hiding this comment

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

This processes file looks great 👌


This document outlines processes and procedures for some common tasks in the charts repository.

## Adding chart maintainers
Copy link
Member

Choose a reason for hiding this comment

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

Perhaps it would help to also add sections for responsibilities of chart maintainers and repo admin roles? Per chat and your note about it as well here? #38 (comment)

Copy link
Member Author

Choose a reason for hiding this comment

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

That's a good idea. I would love to split it up into smaller PRs as it's easier to review and get it merged.


Chart maintainers are defined within the chart itself.
So the procedure for adding maintainers is to add them there.
The pull request which does that should also update [CODEOWNERS](./github/CODEOWNERS) file to that the new maintainer is able to approve pull requests.
One of the existing chart maintainers needs to approve the PR in addition one of the repository admins needs to approve it.
They are then responsible for also granting the new maintainer write permissions to this repository.