Skip to content
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.

Sign up for GitHub

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

fix: explicit instructions about project_id format #384

Merged
merged 1 commit into from
Jan 29, 2025
Merged

fix: explicit instructions about project_id format #384

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions gitlab/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ func main() {
}

switch command {
case "myUserName":
fmt.Printf("Current username is %s\n", user.Username)
// Issues
case "queryIssues":
rawQuery := os.Getenv("ISSUE_QUERY")
Expand Down
23 changes: 23 additions & 0 deletions gitlab/tool.gpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ Param: issue_query: A JSON formatted string that conforms to the API spec for Gi
Name: List Project Issues
Description: List GitLab Issues inside a Project.
Share Context: GitLab Context
Share Tools: Get Current UserName
Credential: ./credential
Param: issue_query: A JSON formatted string that conforms to the API spec for GitLab's Issue Search
Param: project_id: The numeric ID or name of a project in the format `namespace/project_name`.
Expand All @@ -43,6 +44,7 @@ Credential: ./credential
Name: Get Issue Details
Description: Show detailed information about a single Issue.
Share Context: GitLab Context
Share Tools: Search Issues
Credential: ./credential
Param: issue_iid: The numeric IID (Internal ID) of an issue.
Param: project_id: The numeric ID or name of a project in the format `namespace/project_name`.
Expand All @@ -53,6 +55,7 @@ Param: project_id: The numeric ID or name of a project in the format `namespace/
Name: Create Issue
Description: Create a new Issue.
Share Context: GitLab Context
Share Tools: Get Current UserName
Credential: ./credential
Param: project_id: The numeric ID or name of a project in the format `namespace/project_name`.
Param: issue_name: The new issue title.
Expand All @@ -64,6 +67,7 @@ Param: issue_description: The new issue description.
Name: Update Issue
Description: Update values in an existing Issue.
Share Context: GitLab Context
Share Tools: Get Current UserName
Credential: ./credential
Param: issue_iid: The numeric IID (Internal ID) of an issue.
Param: project_id: The numeric ID or name of a project in the format `namespace/project_name`.
Expand All @@ -74,6 +78,7 @@ Param: updates: A JSON-formatted string that conforms to the GitLab API, contain
---
Name: Delete Issue
Description: Deletes an Issue.
Share Tools: Get Current UserName
Share Context: GitLab Context
Credential: ./credential
Param: issue_iid: The numeric IID (Internal ID) of an issue.
Expand All @@ -85,6 +90,7 @@ Param: project_id: The numeric ID or name of a project in the format `namespace/
Name: Add Issue Comment
Description: Adds a new comment on an existing Issue.
Share Context: GitLab Context
Share Tools: Get Current UserName
Credential: ./credential
Param: issue_iid: The numeric IID (Internal ID) of an issue.
Param: project_id: The numeric ID or name of a project in the format `namespace/project_name`.
Expand All @@ -105,6 +111,7 @@ Param: mr_query: A JSON formatted string that conforms to the API spec for GitLa
Name: List Project Merge Requests
Description: List GitLab Merge Requests inside a Project.
Share Context: GitLab Context
Share Tools: Get Current UserName
Credential: ./credential
Param: mr_query: A JSON formatted string that conforms to the API spec for GitLab's Merge Request Search
Param: project_id: The numeric ID or name of a project in the format `namespace/project_name`.
Expand All @@ -131,6 +138,7 @@ Credential: ./credential
Name: Get Merge Request Details
Description: Show detailed information about a single Merge Request.
Share Context: GitLab Context
Share Tools: Get Current UserName
Credential: ./credential
Param: issue_iid: The numeric internal ID of a Merge Request.
Param: project_id: The numeric ID or name of a project in the format `namespace/project_name`.
Expand All @@ -141,6 +149,7 @@ Param: project_id: The numeric ID or name of a project in the format `namespace/
Name: Create Merge Request
Description: Create a new Merge Request.
Share Context: GitLab Context
Share Tools: Get Current UserName
Credential: ./credential
Param: project_id: The numeric ID or name of a project in the format `namespace/project_name`.
Param: mr_name: The new Merge Request title.
Expand All @@ -154,6 +163,7 @@ Param: mr_target_branch: The target git branch.
Name: Update Merge Request
Description: Update values in an existing Merge Request.
Share Context: GitLab Context
Share Tools: Get Current UserName
Credential: ./credential
Param: issue_iid: The numeric internal ID of a Merge Request.
Param: project_id: The numeric ID or name of a project in the format `namespace/project_name`.
Expand All @@ -165,6 +175,7 @@ Param: updates: A JSON-formatted string that conforms to the GitLab API, contain
Name: Delete Merge Request
Description: Deletes a Merge Request.
Share Context: GitLab Context
Share Tools: Get Current UserName
Credential: ./credential
Param: mr_id: The numeric internal ID of a Merge Request.
Param: project_id: The numeric ID or name of a project in the format `namespace/project_name`.
Expand All @@ -175,6 +186,7 @@ Param: project_id: The numeric ID or name of a project in the format `namespace/
Name: Add Merge Request Comment
Description: Adds a new comment on an existing Merge Request.
Share Context: GitLab Context
Share Tools: Get Current UserName
Credential: ./credential
Param: mr_id: The numeric internal ID of a Merge Request.
Param: project_id: The numeric ID or name of a project in the format `namespace/project_name`.
Expand All @@ -186,6 +198,7 @@ Param: comment: The text to use as the body of the comment. Can contain markdown
Name: Approve Merge Request
Description: Approves a Merge Request.
Share Context: GitLab Context
Share Tools: Get Current UserName
Credential: ./credential
Param: mr_id: The numeric internal ID of a Merge Request.
Param: project_id: The numeric ID or url-escaped name of a Project.
Expand All @@ -201,6 +214,13 @@ Param: gitlab_username: A GitLab username.

#!${GPTSCRIPT_TOOL_DIR}/bin/gptscript-go-tool lookupUserID

---
Name: Get Current UserName
Description: Gets the username of the currently authenticated user.
Share Context: GitLab Context
Credential: ./credential

#!${GPTSCRIPT_TOOL_DIR}/bin/gptscript-go-tool myUserName

---
Name: GitLab Context
Expand All @@ -215,6 +235,9 @@ Do show them 'IIDs' - these are very useful.

Do not guess at the correct spelling of projects, usernames, etc. Report to the user that there may be a typo if the resource they requested cannot be found.

A `project_id` must be in the format of `namespace/project_name`, where `namespace` can be a path including `/` characters.
If the namespace is not specified, assume the namespace should be the current user's username unless context suggests otherwise.


## End of instructions for using the GitLab tools

Expand Down
Loading