Skip to content

Commit 3021739

Browse files
committed
Auto merge of #9000 - JohnTitor:owner-add-docs, r=ehuss
Document `could not find the github team` error on `cargo owner --add` When running `cargo owner --add`, the `could not find the github team` error often occurs due to lack of the permissions. Example cases: #5297 (comment), rust-lang/crates.io#2928 I think it's worth documenting that error and the possible solution.
2 parents faf05ac + 4be6c18 commit 3021739

File tree

1 file changed

+22
-5
lines changed

1 file changed

+22
-5
lines changed

src/doc/src/reference/publishing.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -195,8 +195,7 @@ is likely for you to encounter the following message when working with them:
195195

196196
> It looks like you don’t have permission to query a necessary property from
197197
GitHub to complete this request. You may need to re-authenticate on [crates.io]
198-
to grant permission to read GitHub org memberships. Just go to
199-
<https://crates.io/login>.
198+
to grant permission to read GitHub org memberships.
200199

201200
This is basically a catch-all for “you tried to query a team, and one of the
202201
five levels of membership access control denied this”. That is not an
@@ -215,8 +214,9 @@ you will get the error above. You may also see this error if you ever try to
215214
publish a crate that you don’t own at all, but otherwise happens to have a team.
216215

217216
If you ever change your mind, or just aren’t sure if [crates.io] has sufficient
218-
permission, you can always go to <https://crates.io/login>, which will prompt you
219-
for permission if [crates.io] doesn’t have all the scopes it would like to.
217+
permission, you can always go to <https://crates.io/> and re-authenticate,
218+
which will prompt you for permission if [crates.io] doesn’t have all the scopes
219+
it would like to.
220220

221221
An additional barrier to querying GitHub is that the organization may be
222222
actively denying third party access. To check this, you can go to:
@@ -240,8 +240,24 @@ the “Grant Access” button next to its name:
240240

241241
![Authentication Access Control](../images/auth-level-acl.png)
242242

243+
#### Troubleshooting GitHub team access errors
244+
245+
When trying to add a GitHub team as crate owner, you may see an error like:
246+
247+
```text
248+
error: failed to invite owners to crate <crate_name>: api errors (status 200 OK): could not find the github team org/repo
249+
```
250+
In that case, you should go to [the GitHub Application settings page] and
251+
check if crates.io is listed in the `Authorized OAuth Apps` tab.
252+
If it isn't, you should go to <https://crates.io/> and authorize it.
253+
Then go back to the Application Settings page on GitHub, click on the
254+
crates.io application in the list, and make sure you or your organization is
255+
listed in the "Organization access" list with a green check mark. If there's
256+
a button labeled `Grant` or `Request`, you should grant the access or
257+
request the org owner to do so.
258+
243259
[RFC 1105]: https://github.com/rust-lang/rfcs/blob/master/text/1105-api-evolution.md
244-
[Rust API Guidelines]: https://rust-lang-nursery.github.io/api-guidelines/
260+
[Rust API Guidelines]: https://rust-lang.github.io/api-guidelines/
245261
[`authors`]: manifest.md#the-authors-field
246262
[`cargo login`]: ../commands/cargo-login.md
247263
[`cargo package`]: ../commands/cargo-package.md
@@ -256,3 +272,4 @@ the “Grant Access” button next to its name:
256272
[`repository`]: manifest.md#the-repository-field
257273
[crates.io]: https://crates.io/
258274
[oauth-scopes]: https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/
275+
[the GitHub Application settings page]: https://github.com/settings/applications

0 commit comments

Comments
 (0)