From 32d934ed7f9d3fbcfd05c04f8ce9e3ed12e47243 Mon Sep 17 00:00:00 2001 From: Eric Huss Date: Sat, 4 May 2024 08:16:42 -0700 Subject: [PATCH 1/2] triagebot: Add documentation for transfer command. --- src/SUMMARY.md | 1 + src/triagebot/transfer.md | 36 ++++++++++++++++++++++++++++++++++++ 2 files changed, 37 insertions(+) create mode 100644 src/triagebot/transfer.md diff --git a/src/SUMMARY.md b/src/SUMMARY.md index 14bf7beba..cab30a065 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -20,6 +20,7 @@ - [Documentation Updates](./triagebot/doc-updates.md) - [GitHub Releases](./triagebot/github-releases.md) - [Glacier](./triagebot/glacier.md) + - [Issue Transfer](./triagebot/transfer.md) - [Labeling](./triagebot/labeling.md) - [Major Changes](./triagebot/major-changes.md) - [Mentions](./triagebot/mentions.md) diff --git a/src/triagebot/transfer.md b/src/triagebot/transfer.md new file mode 100644 index 000000000..90bdfb543 --- /dev/null +++ b/src/triagebot/transfer.md @@ -0,0 +1,36 @@ +# Issue Transfer + +The `transfer` command allows you to transfer a GitHub issue from one repository to another. + +## Usage + +To transfer an issue to another repository, enter a comment with the form: + +`@rustbot transfer` *repository-name* + +It is recommended to also include a comment explaining why you are transferring. For example: + +``` +Transferring to rust-lang/cargo since this is an issue with how cargo +implements diagnostic reports. + +@rustbot transfer cargo +``` + +**IMPORTANT: There will be no visual indication that the issue is being transferred.** Due to GitHub API limitations, you will not see any activity. **You must reload the page** to view the issue in its new location. It may take a few moments for GitHub to transfer all the data. + +**WARNING:** Transferring is a partially destructive command. For example, labels and milestones that don't exist in the target repository will be removed. + +The transfer command is limited to team members of the rust-lang org, and transfers can only happen to repositories in the rust-lang org. + +## Configuration + +The source repository must have an empty `transfer` table to enable transfers *from* that repository. Issues can be transferred to any repository in the rust-lang org. + +```toml +[transfer] +``` + +## Implementation + +See [`parser/src/command/transfer.rs`](https://github.com/rust-lang/triagebot/blob/HEAD/parser/src/command/transfer.rs) and [`src/handlers/transfer.rs`](https://github.com/rust-lang/triagebot/blob/HEAD/src/handlers/transfer.rs). From 48f4fc40509df46ae7913bdc01cc3acbac66ce99 Mon Sep 17 00:00:00 2001 From: Eric Huss Date: Mon, 6 May 2024 12:16:16 -0700 Subject: [PATCH 2/2] Apply suggestions from fmease MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: León Orell Valerian Liehr --- src/triagebot/transfer.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/triagebot/transfer.md b/src/triagebot/transfer.md index 90bdfb543..af5fa8609 100644 --- a/src/triagebot/transfer.md +++ b/src/triagebot/transfer.md @@ -6,7 +6,7 @@ The `transfer` command allows you to transfer a GitHub issue from one repository To transfer an issue to another repository, enter a comment with the form: -`@rustbot transfer` *repository-name* +`@rustbot transfer ` It is recommended to also include a comment explaining why you are transferring. For example: @@ -19,7 +19,7 @@ implements diagnostic reports. **IMPORTANT: There will be no visual indication that the issue is being transferred.** Due to GitHub API limitations, you will not see any activity. **You must reload the page** to view the issue in its new location. It may take a few moments for GitHub to transfer all the data. -**WARNING:** Transferring is a partially destructive command. For example, labels and milestones that don't exist in the target repository will be removed. +**WARNING:** Transferring is a partially destructive command. For example, labels and milestones that don't exist in the target repository will be removed from the issue. The transfer command is limited to team members of the rust-lang org, and transfers can only happen to repositories in the rust-lang org.