Skip to content
Permalink
Browse files

Add warning about valid assignee to README.md

  • Loading branch information...
vyrondrosos committed Aug 24, 2019
1 parent cd76c5c commit a47e4750fcba797a999a391cda7ffca828b2ac7c
Showing with 7 additions and 4 deletions.
  1. +3 −1 README.md
  2. +3 −2 git-issue.1
  3. +1 −1 git-issue.sh
@@ -98,6 +98,8 @@ You use _git issue_ with the following sub-commands.
The person is specified with his/her email address.
The form `@name` or `name@` can be used as a shortcut, provided it
uniquely identifies an existing assignee or committer.
Note that if you plan to export the issue to a GitHub/GitLab repository, the assignee may be rejected if
it doesn't correspond to a valid username, or if you don't have the necessary permissions.
* `git issue attach`: Attach (or remove with `-r`) a file to an issue.
* `git issue watcher`: Add (or remove with `-r`) an issue watcher.
* `git issue close`: Remove the `open` tag, add the closed tag
@@ -130,7 +132,7 @@ You use _git issue_ with the following sub-commands.
- `GI_AUTHOR` : Author of current issue
- `GI_DATE` : Creation date of current issue

The command can read add/remove or edit any of the issue's attributes.
The command can read, add/remove or edit any of the issue's attributes.
Some potentially useful scripts to be used with this command are in the scripts/ directory.
Remember to inspect the results (e.g `gi git diff`) and commit them with `gi git commit -a`.

@@ -113,6 +113,8 @@ Assign (or remove \fC-r\fP) an issue to a person.
The person is specified with his/her email address.
The form \fC@name\fP or \fCname@\fP can be used as a shortcut, provided it
uniquely identifies an existing assignee or committer.
Note that if you plan to export the issue to a GitHub/GitLab repository, the assignee may be rejected if
it doesn't correspond to a valid username, or if you don't have the necessary permissions.
.RE
.PP
\fBgit issue attach\fP
@@ -167,7 +169,7 @@ Run \fCcommand\fP in every issue directory. The following environment variables
- \fCGI_AUTHOR\fP : Author of current issue
- \fCGI_DATE\fP : Creation date of current issue

The command can read add/remove or edit any of the issue's attributes.
The command can read, add/remove or edit any of the issue's attributes.
Some potentially useful scripts to be used with this command are in the scripts/ directory.
Remember to inspect the results (e.g \fCgi git diff\fP) and commit them with \fCgi git commit -a\fP.

@@ -640,7 +642,6 @@ Edited comment d72c68d
Export modified issues back to GitHub
.ft C
.nf
$ git issue export github dspinellis git-issue-test-issues
$ git issue export github dspinellis git-issue-test-issues # Needs a token with the relevant permissions
Issue b83d92872dc16440402516a5f4ce1b8cc6436344 hasn't been modified, skipping...
Comment a93764f32179e93493ceb0a7060efce1e980aff1 hasn't been modified, skipping...
@@ -27,7 +27,7 @@
# User agent string
# shellcheck disable=SC2034
# SC2034 : USER_AGENT appears unused. Verify use (or export if used externally)
USER_AGENT=https://github.com/dspinellis/git-issue/tree/9a08b51
USER_AGENT=https://github.com/dspinellis/git-issue/tree/4119789

# Determine our script library path
my_IFS=$IFS

0 comments on commit a47e475

Please sign in to comment.
You can’t perform that action at this time.