-
Notifications
You must be signed in to change notification settings - Fork 25
Support root configs in repos named .github
#6
Conversation
92f129a
to
7310c86
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this lgtm! cc/ @probot/maintainers for any other thoughts
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks really good. One comment/question about behavior for the .github
repository below, but otherwise 👍
lib/index.js
Outdated
@@ -94,7 +94,13 @@ async function getConfig(context, fileName, defaultConfig) { | |||
} | |||
|
|||
const baseParams = getBaseParams(params, config[BASE_KEY]); | |||
const baseConfig = await loadYaml(context, baseParams); | |||
let baseConfig = await loadYaml(context, baseParams); | |||
if (baseConfig == null && baseParams.repo === '.github') { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If the repo is named .github
and it is being used with _extends
, I think it should skip looking in the .github
directory entirely and only look at the root. Any opposition to that?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we are going to do that, I would suggest always looking at the root (i.e., not supporting the .github/
dir in a .github
repo).
The only concern I have about doing that is that some projects (your own? I think you mentioned somewhere) already use a .github
repo, and might be confused with an update to probot-config, but this isn't a major issue.
When probot-config is looking at .github
automatically without _extends
, I think it make sense to only support looking at the root, since there's no precedent set for that at this point.
I’m not sure I understand that right, is this adding support to read configuration for Probot apps to look not only in the current repository in the Update: nevermind me, I missed the "Issue: #1" part 🤦♂️ 😫 |
So @bkeepers, are you fine with dropping support for |
This change adds special support for base repos that are named `.github`. In these repositories, configs are not stored in the `.github/` directory as usual, but directly in the root of the repository.
Alright, I updated the change to require configs for |
This change adds special support for base repos that are named
.github
. In these repositories, configs can be stored in the.github/
directory as usual, or directly in the root of therepository.
Issue: #1