Skip to content

Manage GitHub settings via Probot #654

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

Open
wants to merge 14 commits into
base: master
Choose a base branch
from
Open

Manage GitHub settings via Probot #654

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
85cbed8
Manage GitHub settings via Probot
dhoppe May 12, 2020
2cee4c2
Migrate to .erb templates
dhoppe May 12, 2020
e141442
Omit configuration of required_pull_request_reviews, required_status_…
dhoppe May 13, 2020
ce9f1e3
Refactor settings.yml.erb in favor of to_yaml()
dhoppe May 13, 2020
d3a3171
Add required parameters
dhoppe May 13, 2020
b03dd16
Add gsub() because we need to keep the value null
dhoppe May 13, 2020
87b74d2
Make CODEOWNERS configurable
dhoppe May 13, 2020
aef8dea
Refactor CODEOWNERS.erb
dhoppe May 13, 2020
9c738c3
Disable notifications for @voxpupuli/collaborators
dhoppe May 14, 2020
e77e6f5
Prevent new line at the end of file
dhoppe May 14, 2020
be28ac3
Disable pull request reviews for master branch
dhoppe May 14, 2020
1336e19
Allow force pushes and deletions for modulesync branch
dhoppe May 14, 2020
0378109
Remove parameter delete_branch_on_merge, because it is not supported …
dhoppe May 15, 2020
78289bf
Do not force signed commits for master branch
dhoppe May 19, 2020
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: 39 additions & 0 deletions config_defaults.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,39 @@
---
.github/settings.yml:
repository:
private: false
has_issues: true
has_projects: false
has_wiki: false
has_downloads: true
default_branch: master
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe out of scope for this specific PR, but has there been discussion of changing the default branch name to main?

Copy link
Member

Choose a reason for hiding this comment

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

AFAIK there has not been any discussion on this.

allow_squash_merge: true
allow_merge_commit: true
allow_rebase_merge: true
delete_branch_on_merge: true
archived: false
branches:
- name: master
protection:
required_pull_request_reviews:
required_approving_review_count: 1
dismiss_stale_reviews: true
require_code_owner_reviews: true
required_status_checks:
strict: true
contexts: []
enforce_admins: undef
restrictions: undef
required_signatures: true
- name: modulesync
protection:
required_pull_request_reviews: undef
required_status_checks:
strict: true
contexts: []
enforce_admins: undef
restrictions: undef
required_signatures: true
.travis.yml:
before_install:
- yes | gem update --system
Expand Down Expand Up @@ -35,6 +70,10 @@
channels:
- "chat.freenode.org#voxpupuli-notifications"
user: puppet
CODEOWNERS:
permissions:
'.github/settings.yml': '@voxpupuli/project-maintainers'
'*': '@voxpupuli/collaborators'
Copy link
Member

Choose a reason for hiding this comment

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

this will send an email to every collaborator, right? Is that maybe too noisy?

Copy link
Member

Choose a reason for hiding this comment

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

Right now I purposely unwatched a lot of repositories precisely because of it.

Copy link
Member Author

Choose a reason for hiding this comment

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

Damn. This was supposed to be a failsafe, according to the docs of Probot. I will drop the last line, but the first one is necessary:

Gemfile:
required:
':test':
Expand Down
1 change: 1 addition & 0 deletions moduleroot/.github/settings.yml.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<%= @configs.slice('repository', 'labels', 'milestones', 'collaborators', 'teams', 'branches').to_yaml.gsub(/undef/, 'null') %>
5 changes: 5 additions & 0 deletions moduleroot/CODEOWNERS.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<% if @configs['permissions'] -%>
<% @configs['permissions'].each do |key, value| -%>
<%= key %> <%= value %>
<% end -%>
<% end -%>
Copy link
Member

Choose a reason for hiding this comment

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

Untested, but I think this will result in the same:

Suggested change
<% if @configs['permissions'] -%>
<% @configs['permissions'].each do |key, value| -%>
<%= key %> <%= value %>
<% end -%>
<% end -%>
<% @configs['permissions']&.each do |key, value| -%>
<%= key %> <%= value %>
<% end -%>

Copy link
Member Author

Choose a reason for hiding this comment

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

It does. Honestly, how many Ruby books do you have hidden under your pillow? ;)

Copy link
Member

Choose a reason for hiding this comment

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

None, I still consider myself a novice Ruby developer tbh. Just look at a bunch of other devs and PR reviews. Copy that. That's how I learned the language constructs. This one is called the safe navigation operator and was introduced in Ruby 2.3.

Also read the core data structures (Array, Hash, String and Integer) when you deal with them. The list of methods is useful.

Once you have a decent understanding of what's possible, you can express yourself much more powerful.