Warning: possible change in GH API may cause issues with safe-settings

[markjm]

On latest versions:

When a change is triggered and safe-settings runs for a repository, the first change made is for repository settings. Something like

DEBUG (mark): GitHub request: PATCH https://api.github.com/repos/ORG/REPO - 422
    auto_init: true
    visibility: "internal"
    has_issues: false
    has_projects: false
    has_wiki: false
    allow_squash_merge: true
    allow_merge_commit: false
    allow_rebase_merge: false
    allow_auto_merge: true
    delete_branch_on_merge: true
    org: "REDACTED"

This request, however, has started to fail with the below message:

"data":{"message":"Visibility is already internal.","documentation_url":"https://github.com/pricing"}}

In case its relevant: this request also has the nebula header enabled "headers":{"accept":"application/vnd.github.nebula-preview+json"

I do not know where/how to track down possible changes to GH API that might cause this :/

cc @decyjphr

[markjm]

@decyjphr can you please confirm that this is new and broken? or is this just something I only noticed now but not a blocker?

[decyjphr]

I have never seen this before and other customers have not seen this either which makes me think this is new. I have asked GitHub engineering if anything changed in the api.

[decyjphr]

@markjm I tried to recreate this with a test repo., but couldn't. Here is the output from the logs

DEBUG (event): Updating repo with settings ["blue","green","yellow","red","uber","newone","green","blue"] {"mediaType":{"previews":["nebula-preview"]},"name":"test","org":"dec","force_create":true,"description":"description of test repository","homepage":"https://newhome.github.io/home","visibility":"internal","auto_init":true,"has_issues":true,"has_projects":true,"has_wiki":true,"has_downloads":true,"allow_squash_merge":true,"allow_merge_commit":false,"allow_rebase_merge":false,"default_branch":"develop","repo":"test","owner":"dec"}
    id: "c7198708-1789-11ed-8577-96afb59dcb6b"
DEBUG (test): GitHub request: PATCH https://api.github.com/repos/dec/test - 200
    org: "dec"
    force_create: true
    description: "description of test repository"
    homepage: "https://newhome.github.io/home"
    visibility: "internal"
    auto_init: true
    has_issues: true
    has_projects: true
    has_wiki: true
    has_downloads: true
    allow_squash_merge: true
    allow_merge_commit: false
    allow_rebase_merge: false
    default_branch: "develop"

I'll try different combinations to recreate your error. Let me know if I am missing anything. The settings are:

repository:      
  name: test     
  org: dec
  force_create: true 
  description: description of test repository
  homepage: https://newhome.github.io/home
  topics: 
  - blue 
  - green  
  - yellow 
  - red
  visibility: internal
  auto_init: true    
  has_issues: true   
  has_projects: true
  has_wiki: true
  has_downloads: true
  allow_squash_merge: true
  allow_merge_commit: false
  allow_rebase_merge: false 
  default_branch: develop 

[markjm]

@decyjphr was this repo internal before you ran? can you try running on the same repo again now that is internal to see if you can "reapply" those same configs on the same repo?

I can even replicate with a simple raw htttp call

[decyjphr]

@markjm Yes, the repo was already internal. In your API test, can you see if the error happens if there is another change in the settings -- in my case, I change the homepage URL? I am using the code in suborg-scalability branch and it requires there be a change in the repo settings and will not call the API when there are no changes in the repo settings. It could be the reason why I am not seeing this issue.

[mbadd]

using the yadhav/safe-settings:2.0.22-rc.9 image for the safe settings app with debug enabled, I'm getting a similar error (I've anonymized the repo and org name below)

{"level":20,"time":1689054921716,"pid":24,"hostname":"cab73abe3cfb","name":"probot","name":"probot","name":"github","private":true,"visibility":"private","default_branch":"develop","allow_rebase_merge":false,"allow_auto_merge":true,"delete_branch_on_merge":true,"name":"myrepo-beta","org":"my-org","msg":"GitHub request: PATCH https://api.github.com/repos/my-org/myrepo-beta - 422"}