issue create: Add special @me assignee (self) #2004

marclop · 2020-09-28T06:49:24Z

Description

This patch adds a new special handling of the @me string when it is
passed as an assignee, to resolve to the currently authenticated user
login which is then resolved to ID using the already existing flow.

Related issues

Closes #965

marclop · 2020-09-28T06:50:33Z

This differs from the proposed --assign-yourself flag name, but it's easy enough to change if you deem it appropriate.

Kamarulzamansalehudin

marclop · 2020-09-28T07:14:37Z

Once we agree on the flag name I can easily add this same flag to the pr create command.

mislav · 2020-09-29T15:35:35Z

@marclop What do you think of supporting a special assignee name @me that resolves to the current user's name? That way we could reuse existing flags, e.g. issue create -a @me

GitHub web already supports @me in certain areas like issue search, so maybe we could emulate that and eventually support it as input across different commands, e.g. gh issue list -a @me. How would this feel?

marclop · 2020-09-29T15:41:16Z

@mislav That sounds fine to me, specially if it's how the @me mention is going to align across the board throughout the gh CLI and the GitHub Web UI.-

If so, would we simply treat @me as call via the GraphQL API to api.CurrentLoginName? It'd differ to the general tagging from a "normal" user reference so it feels like a good approach.

mislav · 2020-09-29T17:29:52Z

If so, would we simply treat @me as call via the GraphQL API to api.CurrentLoginName?

Yes that was my idea. Would you like to change this PR to go into that direction instead? It would just need to cover the assign functionality in issue create; we can later expand the approach to other commands.

vilmibm · 2020-09-29T19:51:07Z

Sorry for the metadata spam! I'm dizzy with issue triage and mistook this for an issue not a PR 🤦‍♀️

marclop · 2020-09-30T09:17:50Z

@mislav yep, I'll change the title, description and code when I have the chance.

marclop · 2020-09-30T11:25:55Z

d452a8c should implement what we discussed

matschaffer · 2020-10-06T05:56:34Z

@me works for @me! Thanks for picking this up @marclop 🧡

marclop · 2020-10-07T17:37:46Z

@mislav mind a review when you've got time? Thanks!

FeliciaXmL

#8 footer

marclop · 2020-10-14T05:19:43Z

👋 Anyone keen to review this so we can merge it? @mislav or @vilmibm ?

mislav

Sorry for the late review! This looks great for the non-web flow of creating issues/PRs ❤️

However, it looks to me that the web flow for creating issues/PRs would not resolve @me to the username. The web flow is triggered by either:

Using the gh issue/pr create --web flag;
Using the "Continue in browser" option instead of "Submit" in the interactive create flow.

marclop · 2020-10-15T14:18:15Z

@mislav I missed that code path, I'll take a look tomorrow and fix it.

marclop · 2020-10-16T07:37:18Z

@mislav I've written some tests for the flows:

gh issue create -a @me -t <title> -b <body>: Works nicely.
gh issue create -a @me (Interactive, select Submit case): Works nicely with submit case no metadata.
gh issue create --web -a @me, no problem here if there's no issue templates on the repository, if there are, the user is left to choose one and it renders the ?assignees= query param invalid.

There remains a problematic case where the user prompts interactive creation of the issue, but specifies assignees: gh issue create -a @me. We need to make some decisions on this flow, because as it is, there's some issues with it and how the -a @me needs to be handled:

since I have no permissions to triage issues in cli/cli, I'm using my fork

Adding metadata to the issue when `-a` is specified

When -a @me for any other assignee is specified in the issue but the user goes into Add metadata, the assignees will get overwritten by whatever the user chooses (or if the user doesn't add them).

$ ./bin/gh issue create -a @me -R marclop/cli

Creating issue in marclop/cli

? Title test
? Body <Received>
? What's next?  [Use arrows to move, type to filter]
  Submit
> Add metadata
  Cancel

$ ./bin/gh issue create -a @me -R marclop/cli

Creating issue in marclop/cli

? Title test
? Body <Received>
? What's next? Add metadata
? What would you like to add?  [Use arrows to move, space to select, <right> to all, <left> to none, type to filter]
> [ ]  Assignees
  [ ]  Labels
  [ ]  Projects
  [ ]  Milestone

To solve this we need to decide:

Whether we're ignoring -a when interactive is set and the Add Metadata is selected
We're making the user select the assignees directly skipping other fields, appending the current -a ....

Let me know which route I should go and I can work towards that.

marclop · 2020-11-26T15:25:10Z

@mislav Hello? Anybody in the house?

mislav · 2020-12-01T21:26:47Z

Whether we're ignoring -a when interactive is set and the Add Metadata is selected

I think this might get addressed in #2472

Thank you for all the work so far, and sorry for the late review! The ball is in our court now; so please bear with us. 🙇

Signed-off-by: Marc Lopez <[email protected]>

mislav

Fantastic, thank you for all your help!

I've pushed updates to make @me available when listing issues as well, so that support for it is consistent across the board. (It was already supported in gh pr list.)

Kamarulzamansalehudin reviewed Sep 28, 2020

View reviewed changes

samcoe added the community label Sep 28, 2020

vilmibm removed the community label Sep 29, 2020

vilmibm changed the title ~~issue create: Add --self-assign flag~~ support @me for use in assigning things Sep 29, 2020

vilmibm added core This issue is not accepting PRs from outside contributors enhancement a request to improve CLI labels Sep 29, 2020

vilmibm changed the title ~~support @me for use in assigning things~~ issue create: Add --self-assign flag Sep 29, 2020

vilmibm removed core This issue is not accepting PRs from outside contributors enhancement a request to improve CLI labels Sep 29, 2020

marclop changed the title ~~issue create: Add --self-assign flag~~ issue create: Add special @me assignee (self) Sep 30, 2020

vilmibm mentioned this pull request Oct 7, 2020

Create self-assigned issue #965

Closed

FeliciaXmL suggested changes Oct 10, 2020

View reviewed changes

mislav suggested changes Oct 15, 2020

View reviewed changes

marclop force-pushed the f/add-self-assign-flag-to-issue-create branch from a7545c1 to 66f5c06 Compare December 8, 2020 08:11

vilmibm assigned mislav Jan 19, 2021

marclop and others added 3 commits January 22, 2021 20:41

issue/pr create: add "@me" syntax to self-assign

6ad0c57

Signed-off-by: Marc Lopez <[email protected]>

Extend @me replacing behavior to issue list

28c2d04

Use concrete type instead of an interface to avoid forced casting

73da25a

mislav force-pushed the f/add-self-assign-flag-to-issue-create branch from 66f5c06 to 73da25a Compare January 22, 2021 21:05

Add docs for using @me to reference self

e334a1f

mislav approved these changes Jan 22, 2021

View reviewed changes

mislav merged commit 77cc378 into cli:trunk Jan 22, 2021

Uh oh!

issue create: Add special @me assignee (self) #2004

issue create: Add special @me assignee (self) #2004

Uh oh!

Conversation

marclop commented Sep 28, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related issues

Uh oh!

marclop commented Sep 28, 2020

Uh oh!

Kamarulzamansalehudin left a comment

Choose a reason for hiding this comment

Uh oh!

marclop commented Sep 28, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mislav commented Sep 29, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

marclop commented Sep 29, 2020

Uh oh!

mislav commented Sep 29, 2020

Uh oh!

vilmibm commented Sep 29, 2020

Uh oh!

marclop commented Sep 30, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

marclop commented Sep 30, 2020

Uh oh!

matschaffer commented Oct 6, 2020

Uh oh!

marclop commented Oct 7, 2020

Uh oh!

FeliciaXmL left a comment

Choose a reason for hiding this comment

Uh oh!

marclop commented Oct 14, 2020

Uh oh!

mislav left a comment

Choose a reason for hiding this comment

Uh oh!

marclop commented Oct 15, 2020

Uh oh!

marclop commented Oct 16, 2020

Adding metadata to the issue when -a is specified

Uh oh!

marclop commented Nov 26, 2020

Uh oh!

mislav commented Dec 1, 2020

Uh oh!

mislav left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

marclop commented Sep 28, 2020 •

edited

Loading

marclop commented Sep 28, 2020 •

edited

Loading

mislav commented Sep 29, 2020 •

edited

Loading

marclop commented Sep 30, 2020 •

edited

Loading

Adding metadata to the issue when `-a` is specified