Print friendly error when `release create` fails due to missing `workflow` OAuth scope #9791

BagToad · 2024-10-19T03:23:33Z

Resolves #9773 by adding a friendly error message when gh release create fails and it may be due to a missing workflow OAuth scope.

Example leveraging a fork of the repo in #9773:

gh release create v0.1.0 --target a602187ebae72cc0e8101cc46fc116a51c9e9e39 --title foo --notes bar -R bagtoad/bevy-yoetz
HTTP 404: Failed to create release, "workflow" scope may be required
To request it, run gh auth refresh -h github.com -s workflow

andyfeller · 2024-10-21T14:47:08Z

@BagToad : Is there anything you need to go from a draft to a full PR?

I wasn't sure if you created a draft for discussion or feedback purposes. Just making sure to understand what's needed here. 👍

pkg/cmd/release/create/http.go

andyfeller

Solid work! 💪 Some random thoughts and concerns

pkg/cmd/release/create/http.go

pkg/httpmock/stub.go

pkg/cmd/release/create/http.go

pkg/cmd/release/create/create_test.go

@andyfeller

Refactor the logic for checking `workflow` scope checking in releases to be in the positive - check if the scope is there, not check if it isn't there. Then, when the function is called we invert it. Also update comments to be more imperative. This refactor also incorporates @andyfeller's suggestion to use `slices`. Co-Authored-By: Andy Feller <[email protected]>

BagToad · 2024-11-24T00:14:42Z

pkg/cmd/release/create/create_test.go

 			if tt.wantErr != "" {
 				require.EqualError(t, err, tt.wantErr)
-				return
 			} else {
 				require.NoError(t, err)
 			}


Not sure why this return was here, it seems like it might have been a mistake.

I needed to remove it to get my test to initially fail since my test wants a SilentError while also wanting text on stderr 🧐

I think this return would cause tests that wantErr to skip checking stdout and stderr. Some of the tests define empty wantStdout and wantStderr, so removing this return would still work for most:

From trunk:

cli/pkg/cmd/release/create/create_test.go

Lines 833 to 835 in ae87caf

wantStdout: ``,

wantStderr: ``,

wantErr: `a release with the same tag name already exists: v1.2.3`,

cli/pkg/cmd/release/create/create_test.go

Lines 1115 to 1124 in ae87caf

err := createRun(&tt.opts)

if tt.wantErr != "" {

require.EqualError(t, err, tt.wantErr)

return

} else {

require.NoError(t, err)

}

assert.Equal(t, tt.wantStdout, stdout.String())

assert.Equal(t, tt.wantStderr, stderr.String())

From #1552:

You can see the test used to check the resulting release information, too:

cli/pkg/cmd/release/create/create_test.go

Lines 314 to 330 in 0f42c7a

err := createRun(&tt.opts)

if tt.wantErr != "" {

require.EqualError(t, err, tt.wantErr)

return

} else {

require.NoError(t, err)

}

bb, err := ioutil.ReadAll(fakeHTTP.Requests[0].Body)

require.NoError(t, err)

var params interface{}

err = json.Unmarshal(bb, &params)

require.NoError(t, err)

assert.Equal(t, tt.wantParams, params)

assert.Equal(t, tt.wantStdout, stdout.String())

assert.Equal(t, tt.wantStderr, stderr.String())

andyfeller

The inline and function documentation is icing on the cake!

This MR contains the following updates: | Package | Update | Change | |---|---|---| | [cli/cli](https://github.com/cli/cli) | minor | `v2.62.0` -> `v2.63.0` | MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot). **Proposed changes to behavior should be submitted there as MRs.** --- ### Release Notes <details> <summary>cli/cli (cli/cli)</summary> ### [`v2.63.0`](https://github.com/cli/cli/releases/tag/v2.63.0): GitHub CLI 2.63.0 [Compare Source](cli/cli@v2.62.0...v2.63.0) #### What's Changed - Support bare repo creation by [@williammartin](https://github.com/williammartin) in cli/cli#9905 - Refactor the `getAttestations` functions by [@malancas](https://github.com/malancas) in cli/cli#9892 - Added a section on manual verification of the relases. by [@kommendorkapten](https://github.com/kommendorkapten) in cli/cli#9936 - Adding option to return `baseRefOid` in `pr view` by [@daliusd](https://github.com/daliusd) in cli/cli#9938 - Update verification results printing by [@malancas](https://github.com/malancas) in cli/cli#9937 - Fix some multiline command documentation to use `heredoc` strings by [@BagToad](https://github.com/BagToad) in cli/cli#9948 - Print friendly error when `release create` fails due to missing `workflow` OAuth scope by [@BagToad](https://github.com/BagToad) in cli/cli#9791 **Full Changelog**: cli/cli@v2.62.0...v2.63.0 #### Security - A security vulnerability has been identified in the GitHub CLI that could leak authentication tokens when cloning repositories containing git submodules hosted outside of GitHub.com and ghe.com. For more information, see GHSA-jwcm-9g39-pmcw #### New Contributors - [@daliusd](https://github.com/daliusd) made their first contribution in cli/cli#9938 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this MR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

BagToad changed the title ~~Handle missing "workflow" scope in createRelease~~ Print friendly error when release create fails due to missing workflow OAuth scope Oct 19, 2024

BagToad commented Oct 21, 2024

View reviewed changes

pkg/cmd/release/create/http.go Outdated Show resolved Hide resolved

BagToad commented Oct 21, 2024

View reviewed changes

pkg/cmd/release/create/http.go Outdated Show resolved Hide resolved

BagToad commented Oct 21, 2024

View reviewed changes

pkg/cmd/release/create/http.go Show resolved Hide resolved

williammartin mentioned this pull request Oct 31, 2024

gh release create works for some commit hashes but gets weird 404 for others #9773

Closed

BagToad force-pushed the kw/cli-9773-informative-message-for-workflow-scope branch from 5b67887 to 4502498 Compare November 17, 2024 01:49

Handle missing "workflow" scope in createRelease

68f3ef7

BagToad force-pushed the kw/cli-9773-informative-message-for-workflow-scope branch from 4502498 to 68f3ef7 Compare November 17, 2024 02:33

BagToad marked this pull request as ready for review November 17, 2024 02:36

BagToad requested a review from a team as a code owner November 17, 2024 02:36

BagToad requested a review from andyfeller November 17, 2024 02:36

cliAutomation added the external pull request originating outside of the CLI core team label Nov 17, 2024

andyfeller reviewed Nov 21, 2024

View reviewed changes

pkg/cmd/release/create/http.go Outdated Show resolved Hide resolved

pkg/httpmock/stub.go Show resolved Hide resolved

pkg/cmd/release/create/http.go Outdated Show resolved Hide resolved

pkg/cmd/release/create/create_test.go Show resolved Hide resolved

BagToad force-pushed the kw/cli-9773-informative-message-for-workflow-scope branch from f1b794b to 65a26ea Compare November 23, 2024 19:52

BagToad force-pushed the kw/cli-9773-informative-message-for-workflow-scope branch from 65a26ea to a4f96d2 Compare November 23, 2024 20:18

BagToad added 2 commits November 23, 2024 13:19

ScopesResponder wraps StatusScopesResponder

11dc6df

Refactor error handling for missing "workflow" scope in createRelease

deb34d6

BagToad commented Nov 24, 2024

View reviewed changes

andyfeller approved these changes Nov 26, 2024

View reviewed changes

andyfeller merged commit b133f9c into trunk Nov 26, 2024

andyfeller deleted the kw/cli-9773-informative-message-for-workflow-scope branch November 26, 2024 13:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Print friendly error when `release create` fails due to missing `workflow` OAuth scope #9791

Print friendly error when `release create` fails due to missing `workflow` OAuth scope #9791

Uh oh!

BagToad commented Oct 19, 2024 •

edited

Loading

Uh oh!

andyfeller commented Oct 21, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

andyfeller left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

BagToad Nov 24, 2024

Uh oh!

andyfeller Nov 26, 2024

Uh oh!

andyfeller left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

	wantStdout: ``,
	wantStderr: ``,
	wantErr: `a release with the same tag name already exists: v1.2.3`,

	err := createRun(&tt.opts)
	if tt.wantErr != "" {
	require.EqualError(t, err, tt.wantErr)
	return
	} else {
	require.NoError(t, err)
	}

	assert.Equal(t, tt.wantStdout, stdout.String())
	assert.Equal(t, tt.wantStderr, stderr.String())

Uh oh!

Print friendly error when release create fails due to missing workflow OAuth scope #9791

Print friendly error when release create fails due to missing workflow OAuth scope #9791

Uh oh!

Conversation

BagToad commented Oct 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

andyfeller commented Oct 21, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

andyfeller left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

BagToad Nov 24, 2024

Choose a reason for hiding this comment

Uh oh!

andyfeller Nov 26, 2024

Choose a reason for hiding this comment

From trunk:

From #1552:

Uh oh!

andyfeller left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Print friendly error when `release create` fails due to missing `workflow` OAuth scope #9791

Print friendly error when `release create` fails due to missing `workflow` OAuth scope #9791

BagToad commented Oct 19, 2024 •

edited

Loading

From `trunk`: