Skip to content
This repository was archived by the owner on Sep 30, 2024. It is now read-only.

github.go: adjust organization not found error message to indicate that org was manually specified in configuration#45918

Merged
ggilmore merged 6 commits into
mainfrom
git-org-sync-msg
Dec 22, 2022
Merged

github.go: adjust organization not found error message to indicate that org was manually specified in configuration#45918
ggilmore merged 6 commits into
mainfrom
git-org-sync-msg

Conversation

@ggilmore

@ggilmore ggilmore commented Dec 21, 2022

Copy link
Copy Markdown
Contributor

background

One of our customers specifies a number of github organizations (100+) in the configuration for their github enterprise instance.

Example of their configuration:

{
  "url": "https://ghe-scaletesting.sgdev.org",
  "token": "REDACTED",
  "orgs": [
    "org-that-exists", 
    // ...
    "non-existant", // <- this org was deleted
	// ...
  ]
}

Some of these organizations are periodically deleted / removed from their GHE instance. When this occurs, this is the error message they see on their code host configuration page:

Screen Shot 2022-12-21 at 2 44 50 PM

To them, it's not obvious that the organization in this error message is one that they manually specified, as opposed to a transient error that occurred since the last time that Sourcegraph tried to sync. This led to further confusion as to why this error wasn't eventually resolving itself.

solution

This PR clarifies the wording of the error message to indicate the mentioned organization is specifically one that they specified in their configuration. Example:

image

Test plan

CI is sufficient (all this is doing is changing the wording of an error message)

@cla-bot cla-bot Bot added the cla-signed label Dec 21, 2022
@ggilmore ggilmore requested a review from a team December 21, 2022 22:57
@sourcegraph-bot

sourcegraph-bot commented Dec 21, 2022

Copy link
Copy Markdown
Contributor

Codenotify: Notifying subscribers in CODENOTIFY files for diff 6988b62...613333d.

Notify File(s)
@indradhanush internal/repos/github.go
@ryanslade internal/repos/github.go
@sashaostrikov internal/repos/github.go

@ggilmore

Copy link
Copy Markdown
Contributor Author

cc @mike-r-mclaughlin

@ggilmore ggilmore changed the title github.go: adjust organization not found error message to indicate that org was spcecified in configuration github.go: adjust organization not found error message to indicate that org was specified in configuration Dec 21, 2022
@ggilmore ggilmore changed the title github.go: adjust organization not found error message to indicate that org was specified in configuration github.go: adjust organization not found error message to indicate that org was manually specified in configuration Dec 21, 2022
affects github.com and enterprise

@indradhanush indradhanush left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This is great! (Left a suggestion for a typo)

Comment thread CHANGELOG.md Outdated
Co-authored-by: Indradhanush Gupta <indradhanush.gupta@gmail.com>
@ggilmore ggilmore enabled auto-merge (squash) December 22, 2022 16:40
@ggilmore ggilmore merged commit 53262d8 into main Dec 22, 2022
@ggilmore ggilmore deleted the git-org-sync-msg branch December 22, 2022 18:24
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants