-
Notifications
You must be signed in to change notification settings - Fork 0
chore: update README.md #4
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
mafredri
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some suggestions but LGTM
| - Starts a Coder Task using your specified template and preset | ||
| - Posts a single status comment on a GitHub issue | ||
| - Maps GitHub users to Coder users | ||
| - When creating a Coder task, you must specify the Github user ID as an input. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| - When creating a Coder task, you must specify the Github user ID as an input. | |
| - When creating a Coder task, you must specify the Github username as an input. |
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We store the GitHub user ID in the users table and lookup based on that, not the username.
| - Posts a single status comment on a GitHub issue | ||
| - Maps GitHub users to Coder users | ||
| - When creating a Coder task, you must specify the Github user ID as an input. | ||
| - The action then queries the Coder deployment to find the Coder user associated with the given Github user ID. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same here.
README.md
Outdated
| | coder-url | Coder deployment URL | true | - | | ||
| | coder-organization | Coder organization name | true | - | | ||
| | coder-task-name-prefix | Prefix for task name | true | - | | ||
| | coder-template-name | Coder template to use for workspace | true | - | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IIRC our cli makes this optional if there only exists one task template. Open to leaving it required though.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think explicit is better than implicit in this particular use-case.
README.md
Outdated
| | github-issue-url | GitHub issue URL to link this task to | true | - | | ||
| | github-token | GitHub token for API operations | true | - | | ||
| | github-user-id | GitHub user ID to create task for | true | - | | ||
| | coder-template-preset | Template preset to use (optional) | false | - | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What about template version id, expose?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I might leave that until requested.
No description provided.